API Burger Queen

A documentação da API pode ser acessada atraves do Link: BQ API

Índice

• 1. Resumo do projeto
• 1.2 Definições Técnicas
• 2. Implementações Futuras
• 3. Montagem do ambiente de desenvolvimento

---

1. Resumo do projeto.

A aplicação consiste em servidor web que através de uma API rest, integrada a um banco de dados relacional, fornece métodos de manipulação CRUD seguindo o modelo de arquitetura MVC (Model View Controller).
Burger Queen foi desenvolvida anteriormente, como uma aplicação de serviço para gerenciamento de pedidos de um restaurante fast-Food, o objetivo da API BQ é servir como back-end, substituíndo a cloud Firestore do Firebase, possibilitando utilização de rotas para criação de usuários, menus e pedidos.

1.2 Definições Técnicas

• Docker:

A aplicação está encapsulada em um Docker, com imagem do Node. Js integrada ao banco de dados PostgreSQL

• Modelagem:

Para orientar a modelagem do banco de dados, pensando nas necessidade da aplicação Burger Queen, foi realizado um DER (Diagrama Entidade Relacionamento) demonstrado abaixo:

• Documentação:

A Documentação da API foi realizada utilizando Swagger, que facilita o entendimento das rotas e possibilita a execução das requisições, como base nos modelos de payload.

2. Implementações Futuras.

• Desenvolvimento de testes de integração.
• Unificação de rotas Orders e ordersItens.
• Criação de rotas de Histórico e Autenticação.

3. Montagem do ambiente de desenvolvimento.

⚠️ Será necessária a utilização:

• Node.js que contém o npm para instalação das dependências.
• Neste projeto a regras de ESLint estão de acordo com o Airbnb JavaScript Style Guide.
• O deploy foi realizado com Heroku.

🚀 So let's Code

• Clone o projeto na sua máquina executando o seguinte comando no seu terminal:

git clone https://github.com/naereloire/SAP004-burger-queen-api.git

• Instale as dependências do projeto com o comando:

npm install

• Suba a imagem do docker e BD executando:

docker-compose up

Nesse momento serão realizadas as migrations que criarão as tabelas no BD

• Deploy: Antes de realizar o deploy, será preciso configurar seu BD no Heroku

git push heroku master

Após o deploy execute:

heroku run npx sequelize-cli db:migrate --app app_name

Esse projeto faz parte do currículo do Bootcamp da Laboratória Brasil

Desenvolvido por:

🚀 Naere Loire 🚀