API RESTful produzida como Teste Técnico disponível nesse link para a empresa Goomer capaz de gerenciar restaurantes e produtos do seu cardápio.
- Listar todos os restaurantes
- Cadastrar novos restaurantes
- Listar os dados de um restaurante
- Alterar os dados um restaurante
- Excluir um restaurante
- Listar todos os produtos de um restaurante
- Listar um produto de um restaurante
- Criar um produto de um restaurante
- Alterar um produto de um restaurante
- Excluir um produto de um restaurante
- A aplicação infelizmente não está no Docker pois meu notebook é antigo e fraco e não aguenta Docker. 😢
- Não esqueça de preencher o arquivo .env com se usuário e senha do MySQL (pode usar como modelo o arquivo .env.example).
# Clone o repositório
$ git clone https://github.com/mocraveirodev/rango-list.git
# Acesse o diretório
$ cd rango-list
# Instalando dependências
$ yarn
# Instalando dependências
$ yarn
# Iniciando a aplicação em DEV
$ yarn dev
# Iniciando a aplicação em PROD
$ yarn start- Seguindo esses passos, a aplicação estará disponível em: http://localhost:3333/
- Lembre-se de estar com o serviço do MySQL rodando.
- Utilizando um Sistema de Gerenciamento de Banco de dados como o HeidiSQL, crie uma tabela chamada "goomer_lista_rango" e rode o script dsponível no caminho src\database\database.sql para criação das tabelas no banco.
Você pode usar a extensão REST Client do VS Code para realizar as chamadas à API. Na pasta http há exemplos de todas as funcionalidades da aplicação.
Com a aplicação rodando, acesse o link http://localhost:3333/docs/ para visualizar a documentação.
classDiagram
class Restaurants {
<< (PK) >>
id: VARCHAR(36)
name: VARCHAR(255)
image: VARCHAR(255)
created_at: TIMESTAMP
updated_at: TIMESTAMP
}
class Addresses {
<< (PK) >>
id: VARCHAR(36)
postal_code: VARCHAR(255)
street: VARCHAR(255)
number: VARCHAR(255)
complement: VARCHAR(255)
neighborhood: VARCHAR(255)
city: VARCHAR(255)
state: VARCHAR(255)
country: VARCHAR(255)
created_at: TIMESTAMP
updated_at: TIMESTAMP
}
class RestaurantAddresses {
<< (PK) >>
restaurant_id: VARCHAR(36)
address_id: VARCHAR(36)
created_at: TIMESTAMP
updated_at: TIMESTAMP
<< (FK) >>
Restaurants
Addresses
}
class OpeningHours {
<< (PK) >>
restaurant_id: VARCHAR(36)
week_day: ENUM('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday')
open_hour: TIME
close_hour: TIME
created_at: TIMESTAMP
updated_at: TIMESTAMP
<< (FK) >>
Restaurants
}
class Categories {
<< (PK) >>
id: VARCHAR(36)
restaurant_id: VARCHAR(36)
name: VARCHAR(255)
created_at: TIMESTAMP
updated_at: TIMESTAMP
<< (FK) >>
Restaurants
}
class Products {
<< (PK) >>
id: VARCHAR(36)
restaurant_id: VARCHAR(36)
category_id: VARCHAR(36)
name: VARCHAR(255)
image: VARCHAR(255)
price: DECIMAL(10, 2)
created_at: TIMESTAMP
updated_at: TIMESTAMP
<< (FK) >>
Restaurants
Categories
}
class Promotions {
<< (PK) >>
id: VARCHAR(36)
product_id: VARCHAR(36)
description: TEXT
price: DECIMAL(10, 2)
start_datetime: TIMESTAMP
finish_datetime: TIMESTAMP
created_at: TIMESTAMP
updated_at: TIMESTAMP
<< (FK) >>
Products
}
Restaurants --> RestaurantAddresses
RestaurantAddresses <-- Addresses
Restaurants <-- OpeningHours
Restaurants <-- Products
Products <-- Promotions
Products <-- Categories
- Não poder usar ORM foi um dos maiores desafios e me ajudou a me desenvolver bastando na criação de queries SQL.
- Tomar decisões de qual arquitetura e modelagem de banco de dados usar também foi desafiador uma vez que nas minhas experiências já recebia isso pronto, porém baseei minha decisões no que eu vi na minha última experiência.
- Não sou muito boa com REGEX e usei para poder me aprimorar.
- Estar focada em Boas Prática.
- Serviço de tradução das mensagem para que a aplicação esteja preparada para escalar pra outros países.
- Busca de endereço pelo CEP, utilizando algum serviço externo.
- Implementação de autenticação, adicionando uma camada de segurança.
- Implementação e TRANSACTIONS nas interações com o DB para garantir consistência em caso de problemas.
- Interfaces e Injeção de Dependências.
- Refatoração.
- Comprimir fotos enviadas para consumo mais rápido;
- Enviar fotos para um bucket online de imagens (ex.: Amazon S3);
- Inserir campo para url de imagem;
- Aplicar testes de integração.
Feito por Monica Craveiro 💜