Portifólio e Github

Sumário

1. Introdução
2. Onde criar seu portifólio
3. O que colocar no seu portifólio
4. Como tornar o Github seu portfólio
   1. Estilizando seu perfil
   2. Documentando do seus projetos
   3. Utilizando o Github Pages
5. Como apresentar seu portifólio

Introdução

Nesse artigo busco esclarecer alguns pontos sobre criação de portifólios, oferecendo dicas que foram importante para mim na criação do meu próprio (ainda tá em andamento mas um dia sai hein!).

Onde criar seu portifólio

Quando estamos criando um portfólio é comum surgir dúvidas acerca de qual é a melhor opção para tal, criar um site próprio do 0?Utilizar um criador de sites?Utilizar uma plataforma de repositórios tipo o github, gitlabs, gitness.

Bom, ao meu ver as três opções são viáveis porém mudam de acordo com o público alvo e tempo disponível, por isso deixarei uma sugestão em quais situações esses três tipos serão úteis.

• Site próprio ou Site Personalizado: É necessário investimentos maiores de tempo, dinheiro e dedicação em geral, muito mais personalizável e ótimo para criar sua própria marca como desenvolvedor, ideal para apresentações com menos código acerca de seus projetos salientando a problemática e solução oferecida por você para aquele produto (cases de sucesso), assim sendo, é voltado para recrutadores e pessoas menos técnicas em geral.
• Plataforma de Repositórios: O maior investimento nesse tipo de portfólio será o tempo, aqui haverá uma proximidade natural com o quesito técnico do projeto, é interessante oferecer uma aplicação bem documentada utilizando o README salientando tecnologias, tomadas de decisões, descrevendo como rodar o seu projeto. Quais códigos inserir no seu portfólio?

O que colocar no seu portifólio

É comum como estudantes possuirmos projetos acadêmicos, de bootcamps e outros, mas são eles ideais para seu portfólio?

Sim, mas com um porém, busque tornar o projeto "seu". O problema não está em fazer um projeto que todo mundo também fez, por exemplo as ditas Pokedex, está em não personalizar, modificar, incrementar, busque arriscar-se mais em seus projetos para além do que lhe foi ensinado, é um diferencial importante em portfólios.

Alguns pontos que podem te ajudar a "incrementar" seus projetos:

• Há algum ponto que pode ser melhorado?
• Posso acrescentar uma nova funcionalidade?
• Posso fazer esse projeto ficar mais "a minha cara"?

Apesar disso, não busque fazer um código perfeito ou sem falhas, busque se superar e trazer pontos novos para você.

Como tornar o Github seu portfólio

Existem várias plataformas de repositórios como foi citado antes, gitlabs, github, gitness, cabe a você escolher a ideal para seu portfólio. Porém, o github é mais conhecido por iniciantes por isso ficaremos na estilização e documentação de código dentro dessa plataforma.

Estilizando seu perfil

Estilizar seu readme é bastante pessoal, eu particularmente gosto de colocar meus contatos, linguagens com as quais trabalho e frameworks. Vou deixar aqui um link com os badges e templates que eu usei no meu readme além de exemplos de readme:

• Badges: https://github.com/Ileriayo/markdown-badges

• Templates: https://github.com/iuricode/readme-template

• Exemplos de readme: https://github.com/durgeshsamariya/awesome-github-profile-readme-templates/tree/master/templates

Bônus:
Esse é meu readme atualmente

Documentando do seus projetos

A documentação de projetos é utilizada em várias camadas do desenvolvimento de software, mas ela sempre busca se aprofundar no código explicando mais acerca de sua criação. Por isso, aqui utilizaremos o README do repositório do Github para documentar o projeto.

Para garantir uma boa documentação é importante seguir alguns passos como:

• A documentação deve trazer contexto acerca do projeto.
• Um passo a passo de como rodar o mesmo em qualquer máquina (Aconselho acrescentar comandos em ambos, linux e windows)
• Tecnologias utilizadas (bibliotecas, frameworks, linguagens)

Perceba que aqui o foco é inserir o leitor no contexto do projeto e o auxiliar a aprofundar mais nele caso queira.

Um exemplo real de uma documentação feita pelo README:

Por exemplo eu inicio explicando o propósito do código (Um código capaz de gerar e validar um token), explico o tipo de arquitetura utilizada (MVC), listo pontos interessantes como documentação com mkdocs, testes automatizados, somado a tecnologias utilizados, logo abaixo temos os comandos necessários para rodar cada parte da aplicação.

Utilizando o Github Pages

O Github Pages é uma ferramenta capaz de fazer deploy de códigos html, css, javascript (incluindo react), ela pode ser utilizada para subir projetos visuais de frontend, ou até para subir seu portifólio do zero.

Como apresentar seu portifólio

Bom, quando estamos nos vendendo como desenvolvedores é importante se ver como um solucionador de problemas e um estudante obstinado, seus projetos te auxiliarão a mostrar seu comprometimento.

Por isso, coloque projetos que condizem com a vaga no seu currículo em uma seção somente para eles, ou até os apresente na carta de apresentação caso tenha essa opção, e sempre coloque o link do seu portifólio no linkedin na seção de destaques.