Skip to content

Aplicação em React + TypeScript que consome a API do GitHub para exibir informações de usuários e seus repositórios.

Notifications You must be signed in to change notification settings

domfabio/GitHub-Finder

Repository files navigation


🔍 GitHub Finder

🧭 Navegação Rápida


📝 Sobre

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.


✅ Funcionalidades

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

🚀 UI e Deploy


🧩 Principais Dependências

Para a lista completa de dependências e versões, consulte o arquivo package.json.


▶️ Como Configurar o Projeto no VS Code:

📌 Pré-requisitos

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

⚙️ Configurando o Projeto

  1. 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
  1. Instalar Dependências:
npm install
  1. Inicie o servidor de desenvolvimento:
npm run dev
  1. Acesse o projeto no navegador:
    No terminal, pressione Ctrl + Clique no link gerado:
    ➜ Local: http://localhost:5173/

🤝 Contribuição

Se deseja contribuir, siga os passos:

  1. Fork o repositório
  2. Crie uma branch: git checkout -b feature-minha-feature
  3. Faça commit das suas mudanças: git commit -m 'Minha nova funcionalidade'
  4. Faça push para a branch: git push origin feature-minha-feature
  5. Abra um Pull Request

Este projeto é distribuído sob a Open Source License - MIT.
Veja a documentação para mais detalhes.

About

Aplicação em React + TypeScript que consome a API do GitHub para exibir informações de usuários e seus repositórios.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published