An open API service indexing awesome lists of open source software.

https://github.com/jveiiga/api-github-avanti

Projeto by innovation class
https://github.com/jveiiga/api-github-avanti

css3 react vite

Last synced: about 2 months ago
JSON representation

Projeto by innovation class

Awesome Lists containing this project

README

        

# šŸš€ Projeto 02 - Busca de Perfil no GitHub

Este é um projeto React que permite buscar e visualizar informações de perfis públicos do GitHub. O aplicativo consome a API do GitHub para exibir dados como nome, foto de perfil e bio do usuÔrio, seguindo o design proposto no Figma.

---

## šŸ“ Objetivo

O desafio consiste em desenvolver uma aplicação React que permita buscar perfis do GitHub e exibir informações do usuÔrio conforme o layout fornecido.

---

## šŸ”— Link do Layout no Figma

Acesse o layout do projeto no Figma clicando no link abaixo:

[Layout no Figma](https://www.figma.com/proto/DqtFxC6312M32mLt8FpJjq/inovation-class?page-id=22%3A2864&node-id=22-4293&viewport=359%2C115%2C0.25&t=SHsEqEgaMrXGMKwv-1&scaling=scale-down-width&content-scaling=fixed&starting-point-node-id=22%3A4293&show-proto-sidebar=1)

---

## šŸŽÆ Funcionalidades

- **Campo de Busca**: O usuƔrio digita o nome de um perfil do GitHub para buscar informaƧƵes.
- **Exibição de Dados**: Mostra o nome, foto de perfil e bio do usuÔrio.
- **Mensagens de Erro**: Exibe mensagens apropriadas caso o perfil não seja encontrado.
- **Design Personalizado**: Interface estilizada conforme o layout do Figma.
- **Experiência do UsuÔrio (opcional)**: Melhorias como spinner de carregamento e efeitos visuais.

---

## āœ… Requisitos para o Desenvolvimento

1. Criar um campo de busca para o usuƔrio digitar o nome de um perfil do GitHub.
2. Consumir a API do GitHub e exibir os seguintes dados do usuƔrio:
- Nome do usuƔrio.
- Foto de perfil.
- Bio.
3. Exibir mensagens de erro caso o perfil não seja encontrado.
4. Estilizar a aplicação conforme o design do Figma.
- Ɖ permitido o uso de frameworks CSS como **Bootstrap**, **TailwindCSS** ou outros.
5. (Opcional) Melhorar a experiência do usuÔrio com:
- Efeitos visuais.
- Indicador de carregamento durante a requisição.

---

## šŸš€ Tecnologias Utilizadas

- **React**: Biblioteca principal para construção da interface.
- **CSS/TailwindCSS (opcional)**: Estilização personalizada para a interface.
- **API do GitHub**: Fonte de dados do projeto.

---

## šŸ“ Estrutura do Projeto

```
src/
ā”œā”€ā”€ assets/
│ └── images/ # Imagens utilizadas no projeto
ā”œā”€ā”€ components/
│ └── Loading.jsx # Componente de carregamento (opcional)
│ └── ProfileCard.jsx # Componente para exibir informaƧƵes do perfil
ā”œā”€ā”€ App.jsx # Componente principal da aplicação
ā”œā”€ā”€ App.css # Estilos globais
└── index.js # Ponto de entrada do React
```

---

## šŸ”§ Como Executar o Projeto

### PrƩ-requisitos

- Node.js instalado
- Gerenciador de pacotes (npm ou yarn)

### Passos

1. **Clone este repositório**:
```bash
git clone https://github.com/jveiiga/api-github-avanti.git
cd api-github-avanti
```

2. **Instale as dependĆŖncias**:
```bash
npm install
```

3. **Execute o servidor de desenvolvimento**:
```bash
npm run dev
```

4. **Abra o navegador** e acesse:
```
http://localhost:5173
```

---

## šŸ› Tratamento de Erros

- **UsuÔrio não encontrado**: Exibe uma mensagem amigÔvel caso o nome de usuÔrio não exista.
- **Limite de requisiƧƵes excedido**: Caso a API do GitHub retorne um erro 403, sugere ao usuƔrio tentar novamente mais tarde.

---

## šŸ“§ Contato

Feito com šŸ’» por [Jeferson Veiga](https://github.com/jveiiga).
**Email:** [email protected]