gsoaresdz/github-api

🌐 Este projeto oferece uma aplicação web que permite aos usuários buscar dados de usuários do GitHub.

GitHub API

Sobre   |   Features   |   Tecnologias   |   Requerimentos   |   Execução   |   Licença   |   Autor

🎯 Sobre

Este projeto oferece uma aplicação web que permite aos usuários buscar dados de usuários do GitHub utilizando a API pública do GitHub. A interface fornece um formulário simples para inserir o nome do usuário do GitHub e exibir seus detalhes, incluindo repositórios, seguidores e seguindo.

✨ Features

✔️ Feature 1: Busca de informações de usuários do GitHub.

✔️ Feature 2: Exibição de repositórios, seguidores e seguindo.

🚀 Tecnologias

As seguintes ferramentas foram usadas neste projeto:

• Front-end
  • HTML / CSS / TypeScript
  • React (^17.0.2)
  • React Router Dom (^5.2.0)
  • Axios (^0.27.2)
  • Bootstrap (^5.0.2)
  • Node-sass (4.14.1)
• Ferramentas de Desenvolvimento
  • TypeScript (^4.1.2)
  • Jest e Testing Library para testes

✅ Requerimentos

Antes de iniciar 🏁, você precisa ter Node.js (recomenda-se a versão LTS mais recente) e npm ou Yarn instalados.

🏁 Execução

# Clone do projeto
$ git clone https://github.com/gsoaresdz/github-api.git

# Instale as dependências
$ yarn install
# ou
$ npm install

# Inicie o servidor de desenvolvimento
$ yarn start
# ou
$ npm start

A aplicação será aberta automaticamente no navegador padrão.

📝 Observações

• Recomendamos a utilização do Visual Studio Code (VSCode) (versão mais recente) como IDE para desenvolvimento, devido à sua excelente integração com TypeScript e React. Certifique-se de instalar as extensões recomendadas para React e TypeScript.

📝 Licença

Este projeto está sob licença do MIT. Para obter mais detalhes, consulte o arquivo LICENSE.

Feito com ❤️ by gsoaresdz

 

De volta ao topo