Involved Git

Aplicativo web para busca de perfis no GitHub.

O desafio

Construir uma aplicação para consulta de perfis do GitHub.

Principais requisitos:

• Permitir a pesquis de usuários por nome e exibir o resultado da pesquisa na mesma página
• Permitir que sejam feitas anotações sobre o usuário
• Mostrar os repositórios do usuário de maneira páginada
• Mostrar página 404 quando o usuário não existir

Pontos extras:

• Testes unitários
• Implementar autenticação utilizando OAuth

A solução

Aplicação SPA construida com AngularJs

O que foi implementado

• Busca em tempo real de usuários por nome e/ou login
• Listagem paginada com todos os usuários encontrados
• Card de usuário na busca com os seguintes dados
  • Avatar (oculto quando for mobile)
  • Nome completo (caso possua)
  • Nome de usuário
  • Total de repositórios e forks
  • Link para visualizar o perfil no github
• Página com os detalhes do usuário e seus repositórios (somente criados pelo usuário)
• Listagem paginada com todos os repositórios do usuário
• Card de repositórios com as seguintes informações
  • Nome do repositório
  • Descrição (caso haja)
  • Principal tecnologia utilizada
  • Total de forks e stars
  • Link para visualizar o repositório no GitHub
• Opção para visualizar e adicionar comentários sobre o usuário
  • Mostrado em uma janela modal
• Salvar comentários em local storage

O que ainda falta implementar

• Escrever testes
• Implementar autenticação utilizando OAuth
  • Autenticação implementada no branch oAuth mas não funcional

Tecnologias utilizadas

• Yeoman FountainJs Angular 1 Generator - gerador de scaffolding
• SASS - pré processador de CSS
• Bower - gerenciador de pacotes
• Gulp - automatizador de tarefas
• Jasmine - framework para testes de unidade
• Karma - executor de testes
• AngularJs - framework Javascript
• MaterializeCss - framework CSS
• Firebase - infraestrutura de serviços
• GitHub Api V3 - api restful do GitHub

Rodando a aplicação

Instale as dependências do projeto utilizando o comando

npm install
bower install

Utilizando os comando do NPM

• npm build compilar o projeto na pasta dist
• npm serve executar o projeto utilizando browser sync
• npm serve:dist executar o projeto utilizando a versão de código otimizada na pasta dist
• npm test executar os testes de unidade utilizando o Karma
• npm test:auto executar os testes de unidade de maneira assistida

Ou utilizando os comandos do Gulp

É necessário instalar o gulp-cli globalmente npm install -g gulp-cli

• gulp or gulp build
• gulp serve
• gulp serve:dist
• gulp test
• gulp test:auto

Se você não tiver o gulp-cli instalado terá o seguinte erro:

/usr/local/lib/node_modules/gulp/bin/gulp.js:121 gulpInst.start.apply(gulpInst, toRun); TypeError: Cannot read property 'apply' of undefined