Challenge Developer Backend - Goomer 💻

O desafio consiste no desenvolvimento de uma API REST
Segue as instruções no link abaixo:

https://github.com/goomerdev/job-dev-backend-interview

Documentação da API com Swagger

A documentação da API fica na rota: http://localhost:5050/api/api-docs

Pré-requisitos

• Node.js instalado
• npm (gerenciador de pacotes do Node.js) instalado
• PostgreSQL instalado
• Docker instalado, caso prefira executar a API por ele

Configurando o Banco de Dados e Rodando a API Manualmente

1. Faça o clone do repositório
2. Na raiz do projeto execute npm install para instalar as dependências
3. Inicie o PostgreSQL na sua máquina e crie um banco de dados para a aplicação, caso deseje executar os testes é necessário criar um database somente para testes.
4. Crie e configure o arquivo .env na raiz do projeto com as seguintes variáveis ambiente:

• DATABASE_URL_DEVELOPMENT=postgresql://USERNAME:PASSWORD@HOST:PORT/DATABASE_NAME?schema=public
• DATABASE_URL_TEST=postgresql://USERNAME:PASSWORD@HOST:PORT/DATABASE_NAME?schema=public
• API_PORT=, default: 5050 - Opcional

5. npm run migration:run para aplicar as migrations no banco de dados de produção que você criou
6. npm run migration:all para aplicar as migrations tanto no banco de dados de produção quanto no de testes
7. npm run build faz o build da API
8. npm start executa a API

Rodando a API com Docker

1. Faça o clone do repositório
2. Para rodar o container do docker execute npm run up, pode demorar para iniciar.
3. Para encerrar o container execute npm run down

A API_PORT padrão é 5050, logo o link fica: http://localhost:5050

APIs construídas no desafio

• Criar Restaurante

• Listar Restaurantes

• Listar um Restaurante

• Atualizar Restaurante

• Excluir Restaurante

• Criar Produto de Restaurante

• Listar Produtos de Restaurante

• Listar um Produto de Restaurante

• Atualizar Produto de Restaurante

• Excluir Produto de Restaurante

Requerimentos da API

• Requerimentos