Folder Structure

grid-motors/
├── prisma/
│   ├── migrations/          # Database migrations
│   └── schema.prisma        # Database schema
├── prisma.config.ts         # Prisma 7 configuration
├── src/
│   ├── auth/                # Authentication, JWT strategy and guards
│   ├── cars/                # Car and accessories management
│   ├── common/              # Global filters, validators and providers
│   ├── reservations/        # Rental business rules
│   ├── users/               # User management and integrations
│   ├── main.ts              # Application entry point
│   └── app.module.ts
├── test/                    # E2E tests
├── .env                     # Local environment (ignored by Git)
├── .env.example             # Local environment template
├── .env.docker.example      # Docker environment template
├── .gitignore
├── docker-compose.yml       # API, PostgreSQL and Redis services
├── Dockerfile               # Multi-stage production build
└── README.md

The .env file is intentionally ignored by Git.

Use one of the provided examples to create your local configuration:

• .env.example → running the API locally
• .env.docker.example → running the complete environment with Docker Compose

🗄️ Database Schema

The API uses a relational database structure managed by Prisma ORM.

erDiagram
    User {
        String id PK
        String name
        String cpf UK
        DateTime birth
        String email UK
        String password
        String cep
        String street
        String neighborhood
        String city
        String state
        String qualified
        DateTime createdAt
        DateTime updatedAt
    }
    
    Car {
        String id PK
        String model
        String color
        Int year
        Float value_per_day
        Int number_of_passengers
        DateTime createdAt
        DateTime updatedAt
    }
    
    Accessory {
        String id PK
        String description
        String carId FK
        DateTime createdAt
        DateTime updatedAt
    }
    
    Reservation {
        String id PK
        DateTime start_date
        DateTime end_date
        Float final_value
        String userId FK
        String carId FK
        DateTime createdAt
        DateTime updatedAt
    }

    User ||--o{ Reservation : "makes"
    Car ||--o{ Reservation : "has"
    Car ||--o{ Accessory : "has"

🚀 Running the Project

Requirements

Make sure you have installed:

• Node.js 20+
• Docker Engine
• Docker Compose V2

Check your environment:

docker --version
docker compose version
node -v
npm -v

🐳 Running with Docker (recommended)

Docker Compose starts the complete application environment:

• NestJS API
• PostgreSQL database
• Redis cache

1. Clone the repository

git clone https://github.com/niqueborges/grid-motors.git
cd grid-motors

2. Configure Docker environment variables

Create your .env file:

cp .env.docker.example .env

Example:

PORT=3000
DATABASE_URL="postgresql://postgres:postgres@db:5432/grid_motors?schema=public"
JWT_SECRET="change-me"
REDIS_HOST=redis
REDIS_PORT=6379

Inside Docker, services communicate using container names:

PostgreSQL: db:5432
Redis: redis:6379

3. Build and start containers

docker compose up --build -d

Check running containers:

docker ps

Expected containers:

grid-motors-api
grid-motors-db
grid-motors-redis

The API will be available at:

http://localhost:3000/api/v1

Swagger documentation:

http://localhost:3000/api/v1/api-docs

The API container automatically runs Prisma migrations:

npx prisma migrate deploy

💻 Running locally (API outside Docker)

This option runs PostgreSQL and Redis using Docker while running NestJS locally.

1. Install dependencies

npm install

2. Configure local environment

Create your local .env:

cp .env.example .env

Example:

PORT=3000
DATABASE_URL="postgresql://postgres:postgres@localhost:5433/grid_motors?schema=public"
JWT_SECRET="change-me"
REDIS_HOST=localhost
REDIS_PORT=6379

3. Start infrastructure services

Start PostgreSQL and Redis containers:

docker compose up -d db redis

Local services:

PostgreSQL: localhost:5433
Redis: localhost:6379

4. Generate Prisma Cliente and database migrations

npx prisma client and generatebase migrations

npx prisma generate
npx prisma migrate dev

5. Start the application

Development mode:

npm run start:dev

📚 API Documentation

Swagger documentation:

http://localhost:3000/api/v1/api-docs

Authentication flow:

1. Create a user.
2. Login:

POST /api/v1/auth/login

3. Copy the JWT token.
4. Click Authorize in Swagger and provide the token.

🧠 Technical Decisions & Features

Key design decisions implemented in the API:

• **Dependency Injection & Repository Pattern:**Services are decoupled from Prisma through repository abstractions, keeping business logic independent from infrastructure details.
• **Rate Limiting:**The API uses @nestjs/throttler to protect endpoints against excessive requests.
• **Redis Caching:**Frequently accessed resources, such as the car catalog, can be cached to improve performance.
• **Reservation Concurrency Control:**Database transactions and locking strategies prevent conflicting reservations for the same vehicle.
• **Historical Rental Values:**Final rental values are stored during reservation creation, preserving historical consistency even if prices change later.
• **Global Exception Filter:**Centralized exception handling provides consistent API responses.
• JWT Authentication: Stateless authentication using access tokens.

🧪 Testing

Run unit tests:

npm run test

Run coverage:

npm run test:cov

Run E2E tests:

npm run test:e2e

Developed by Monique Borges.