base-readme

base-readme.md

Busca Git

Aplicação desenvolvida utilizando a API do GitHub, para realizar busca de usuários, utilizando a lib axios para requisições e respostas.

📒 Índice

• Descrição
• Requisitos Funcionais
  • Features
• Tecnologias
• Endpoints
• Design
  • Cores
  • Fontes
  • Ícones
• Instalação
• Licença

📃 Descrição

Aplicação desenvolvida utilizando a API do GitHub, para realizar busca de usuários, utilizando a lib axios para requisições e respostas.

📌 Requisitos Funcionais

• Validação de usuários
  
• Consulta e exibição dos dados do usuários
  
• Salva os dados do usuário
  
• Mostra vacinas obrigatórias
  

Features

• Requisição a API
  
• Responsividade
  

💻 Tecnologias

• HTML
• CSS
• JavaScript
• axios

📍 Endpoints

Endpoint	Resumo	Autenticação
GET /products	Responsável por listar todos os produtos	Não
GET /products/:id	Responsável por exibir um produto especifico por seu ID	Não
POST /products	Responsável por cadastrar um produto	ROLE_ADMIN
PUT /products/:id	Responsável por atualizar um produto, informando o ID no Path e via corpo de requisição as informações	ROLE_ADMIN
PUT /products/:id	Responsável por deletar um produto, informando o ID no Path	ROLE_ADMIN
GET /swagger-ui/index.html	Responsável por servir a documentação dos recursos da API
GET /h2-console	Responsável por acesso ao H2 Database

🎨 Design

• O modelo final para versão desktop e mobile está disponível na pasta ./design

• Cores
  

  • #323236
    

• Fontes
  

  • Avenir, Helvetica, Arial, sans-serif

• Ícones
  

  • Feather

🚀 Instalação

  # Clone este repositório:
  $ git clone https://github.com/CleilsonAndrade/Busca_Git.git
  $ cd ./Busca_Git

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---

Feito com 💜 by CleilsonAndrade