🎯 Github Profile

🚀 Desafio Front End | Compass.UOL

Tecnologias   |    Projeto   |    Como rodar   |    Licença

🚀 Tecnologias

💻 Projeto

Esse projeto é uma plataforma para acesso aos dados de perfis de usuários do Github. O usuário pode fazer login com sua conta do Github, pesquisar por um usuário especifico, listar os seus repositórios e listar seus repositórios favoritos.

Esse é um desafio técnico para a vaga de Front End Developer na Compass UOL.

🔥 Demo: https://profile-git.herokuapp.com/

🚀 Checklist

• Login com Github;
• Pesquisa por usuários;
• Listar repositórios de um usuário;
• Listar repositórios favoritos de um usuário;
• Cache de dados;
• Loading screen;
• Implemetar a metodologia BEM CSS;
• Melhorar resposividade da Dashboard (Tablet e Mobile);
• Subistituir o loading por Skeleton para melhorar o UX;
• Testes unitários;
• Testes de integração;
• Deploy;

🔧 Como rodar

É necessário ter instalado:

• Git
• Node.js
• Yarn

🗂 Faça um clone do projeto

git clone https://github.com/goncadanilo/github-profile.git

📥 Instale as dependências

# Acesse o diretório do projeto
cd github-profile

# Instale as dependências
yarn

⚙️ Defina as variáveis de ambiente

Será necessário definir as seguintes variáveis de ambiente:

GITHUB_APP_CLIENT_ID=<github-client-id>
GITHUB_APP_CLIENT_SECRET=<github-client-id>

Para saber como gerar essas variáveis de ambiente, acesse o link abaixo:

https://docs.github.com/pt/developers/apps/building-oauth-apps

💡 OBS: Quando for criar o OAuth App no github, defina o callback como: http://localhost:3000/api/auth/ para executar o projeto em ambiente local.

⚡ Inicie a aplicação

yarn dev

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Feito com ♥ by Danilo Gonçalves. Me adicione no LinkedIn 👋