/waiter-api

Projeto desenvolvido durante o evento 'O Poder do Javascript'

Primary LanguageTypeScript

GitHub language count Repository size GitHub last commit

✅ Waiter Api - Concluído ✅

Sobre • Layout • Como executar • Estrutura de arquivos • Tecnologias • Autores •

💻 Sobre o projeto

Projeto desenvolvido durante o evento 'O Poder do Javascript' ministrado pelo Mateus Silva, onde construimos o backend e front-end (web e mobile) de um aplicativo para controlar os pedidos de um restaurante.

🎨 Diagrama Entidade Relacionamento

DER

🚀 Como executar o projeto

Este projeto é dividido em três partes:

  1. Frontend - App
  2. Frontend - Web
  3. Backend (Neste repositório)

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git e Node.js.

Para o desenvolvimento desse projeto, foi utilizado Docker para criar o banco de dado MongoDB.

Executando o projeto

🧭 Rodando a aplicação Backend
 # Clone este repositório
 $ git clone https://github.com/VanessaSwerts/waiter-api.git

 # Acesse a pasta do projeto no seu terminal/cmd
 $ cd waiter-api

 # Instale as dependências
 $ yarn install
 
 # Gere a build
 $ yarn build 

 # Execute a aplicação
 $ yarn dev 
 
 # O servidor irá rodar em http://localhost:3000

📁 Estrutura de arquivos

Atualizado 15/11/2022

api
├─ .gitignore
├─ package.json
├─ src
│  ├─ app
│  │  ├─ models
│  │  │  ├─ Category.ts
│  │  │  ├─ Order.ts
│  │  │  └─ Product.ts
│  │  └─ useCases
│  │     ├─ categories
│  │     │  ├─ createCategory.ts
│  │     │  ├─ deleteCategory.ts
│  │     │  ├─ listCategories.ts
│  │     │  └─ listProductsByCategory.ts
│  │     ├─ orders
│  │     │  ├─ createOrder.ts
│  │     │  ├─ deleteOrder.ts
│  │     │  ├─ listOrders.ts
│  │     │  └─ updateOrderStatus.ts
│  │     └─ products
│  │        ├─ createProduct.ts
│  │        └─ listProducts.ts
│  ├─ index.ts
│  └─ router.ts
├─ tsconfig.json
├─ uploads
│  ├─ 1668527760118-quatro-queijos.png
│  ├─ 1668528957762-frango-catupiry.png
│  └─ 1668529163867-coca-cola.png
└─ yarn.lock

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

API (Node JS)

Veja o arquivo package.json

🦸 Autores


Vanessa Swerts