Skip to content

allankildare/github-explorer

Repository files navigation

GitHub Explorer

React TypeScript Vite SASS React Query

Captura de tela que mostra a página inicial da aplicação, com um texto introdutório e um campo para busca de informações de um usuário do GitHub qualquer

Esta aplicação é um desafio maior, buscando ultrapassar alguns horizontes de quando fiz uma aplicação usando HTML, CSS e JavaScript Vanilla (disponível neste repositório).

Você poderá:

  • Buscar/Listar todos os repositórios publicos de um usuário do github
  • Dado um repositório, listar todas as branches
  • Dado uma branch, listar todos os commits daquela branch

Se trata de um desafio técnico e no tempo oferecido eu consegui desenvolver satisfatoriamente o proposto. Ainda assim, existem pontos de melhorias já mapeadas, são elas:

  • Separação de componentes independentes
  • Criação de estilizações em módulos do Sass (possível criação de um tema)
  • Adição de regras do Eslint para melhorar a experiência de desenvolvimento e boas práticas de código
  • Instalação do Jest e Testing Library, criação de testes unitários

Como instalar

Para clonar, você precisará ter configurado a autenticação SSH (fortemente recomendada):

git clone git@github.com:allankildare/github-explorer.git

Ao clonar, abra o diretório do projeto e instale as dependências:

yarn install

Rodar o projeto

O comando usado é o padrão dev, para isso rode em seu terminal o seguinte comando:

yarn dev

Sua aplicação estará rodando por padrão na porta 3000 (verifique se está disponível)

Deploy

Para fazer o deploy usei o serviço gratuito da Netlify, o website está disponível neste link.

About

Aplicação web para exploração de informações com a API do GitHub

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors