teste-técnico

Documentação

• 2 Arquivos swagger criados (.json e .yaml), o .json é nescessário para rodar a documentação como uma rota na API a partir da lib integrada, e o .yaml é um padrão que achei interessante deixar.
• A documentação está ná ordem de Tags que precisam ser feitas para o serviço funcionar 100%

Dependências

• NodeJS (Utilizando a versão 18.12.1 LTS pelo NVM)
• NPM
• Postgres (Utilizando a versão 15.1)

Pacotes Utilizados

Produção

• DOTENV
• ESM
• EXPRESS
• PG
• SEQUELIZE
• MOMENTJS
• SWAGGER-UI-EXPRESS

Dev

• NODEMON
• ESLINT

Instalação

• Após clonar o projeto, rodar:

    sudo npm install

• Após instalar, deve criar o banco (recomendo usar PGAdmin ou outro app, caso não possa, use o terminal):

  sudo -u postgres psql #para conectar como user postgres, ou como desejar;
  CREATE DATABASE <Nome-do-banco> ;

• Após criar o banco de dados, deve criar um arquivo .env com os seguintes campos:

  API_PORT=3333
  POSTGRES_HOST=localhost
  POSTGRES_DB= #Nome da database;
  POSTGRES_USERNAME=postgres
  POSTGRES_PASSWORD= #Sua senha do postgres
  POSTGRES_PORT=5432
  TIMEZONE=America/Sao_Paulo

• Após a instalação rodar o servidor:

    sudo npm run dev

Nota: A api rodará em http://localhost:3333 Nota: A documentação estará na rota http://localhost:3333/api-docs

Modelagem do Banco de dados

Nota: Modelagem feita no BR Modelo Web

Padrão MVC

• O padrão adotado para o projeto foi o MVC(Model, View, Controller) muito difundido junto a lib do Express.