Vehicle Challenge

Desafio de cadastro de veiculos com Node.js e Angular

Requisitos

Node.js 20
Docker
Docker Compose

Frontend

O frontend utiliza Angular v17 com Material UI

Backend

O backend utiliza Fastify, Drizzle ORM, banco de dados PostgreSQL, Zod para validação das requisições e Mocha para os testes.

Postman Collection para auxiliar a realização das requisições caso necessário

Inicialização

A inicialização pode ser feita manualmente ou com Makefile, utilizando o comando 'make' na raiz do projeto

# Makefile
make

# Frontend
cd client
npm ci
npm start # Inicializa o frontend na porta 4200

# Backend
cd server
cp .env.example .env
docker-compose up -d # Inicializa o banco de dados PostgreSQL local
npm ci
npm run db:push # Roda as migrations do banco de dados
npm run dev # Inicializa o backend na porta 3000

Estrutura de arquivos:

server/
├── src/
│   ├── modules/
│   │   ├── vehicles/
|   |       ├── vehicle.controller.ts -> camada responsável por receber as requisições HTTP
|   |       ├── vehicle.errors.ts -> trata os erros específicos de cada request
|   |       ├── vehicle.schema.ts -> validação dos campos do veículo para garantir que os dados estão corretos
|   |       ├── vehicle.repository.ts -> camada responsável por se comunicar diretamente com o banco de dados
|   |       ├── services/ -> Serviços responsáveis por tratar cada caso de uso (Create, Update, Delete, FindById, FindAll)
|   |           ├── __tests__ -> Testes específicos para cada requisição do recurso "/vehicles"
│   ├── common/ ->
│   │   ├── db -> configurações do banco de dados como schemas e migrations
│   │   ├── plugins -> configurações de plugins do fastify como a conexão do banco de dados e o shutdown da aplicação
│   │   ├── errors -> tratamento de erros da aplicação
│   ├── app.ts -> Configuração do fastify
│   ├── main.ts -> Entrypoint da aplicação
├── tests/
│   ├── vehicle.ts -> Utilitarios para criação de veiculos nos testes