- 📝 Sobre
- ✅ Funcionalidades
- 🚀 UI e Deploy
- 🧩 Principais Dependências
▶️ Como Configurar o Projeto no VS Code- 🤝 Contribuição
Projeto desenvolvido durante o curso Formação Front-end - HTML, CSS, JavaScript, React e +, utilizando React com TypeScript. A aplicação consome a API pública do GitHub para exibir informações detalhadas de usuários e seus repositórios.
Este projeto tem como foco a prática de consumo de APIs REST, manipulação de estado com React Hooks e uso do React Router para navegação entre páginas.
Com essa aplicação é possível:
- 🔎 Buscar usuários do GitHub
- 👤 Exibir detalhes do perfil como avatar, localização, seguidores e seguindo
- 📦 Visualizar os 5 repositórios mais populares do usuário, ordenados por número de estrelas
- React – Framework para construção da interface
- TypeScript – Tipagem estática
- React Router DOM – Para navegação entre páginas
- Vite – Bundler leve e rápido
Para a lista completa de dependências e versões, consulte o arquivo package.json
.
Antes de prosseguir com a configuração, certifique-se de ter todos os pré-requisitos instalados corretamente para evitar erros durante a instalação e execução do projeto:
Git 2.4+
Node.js 12+
Live Server
- Clone este repositório:
Abra o VS Code, pressione
Ctrl + Shift + P
, digite "Git Clone" e cole o link do repositório:
https://github.com/domfabio/GitHub-Finder.git
- Instalar Dependências:
npm install
- Inicie o servidor de desenvolvimento:
npm run dev
- Acesse o projeto no navegador:
No terminal, pressioneCtrl + Clique
no link gerado:
➜ Local: http://localhost:5173/
Se deseja contribuir, siga os passos:
- Fork o repositório
- Crie uma branch:
git checkout -b feature-minha-feature
- Faça commit das suas mudanças:
git commit -m 'Minha nova funcionalidade'
- Faça push para a branch:
git push origin feature-minha-feature
- Abra um Pull Request
Este projeto é distribuído sob a Open Source License - MIT.
Veja a documentação para mais detalhes.