devices-api

Description

REST API using NestJS framework (based on instructions present at CHALLENGE.md)

Running inside docker

For more information on installing and configuring the Docker Engine: https://docs.docker.com/engine/install/

The project is containerized and can be run via docker-compose.yaml

docker compose up

Running locally

The project uses Node.js v22 and dependencies are managed via pnpm

The application will need to connect to PostgreSQL, which can be provisioned from the docker-compose.yaml if necessary.

Project setup

# Configuring locally

npm i -g corepack@latest;

corepack enable pnpm;

corepack use pnpm@latest-10;

pnpm install;

Environment variables

The necessary environment variables are listed at .env.example

# Creating the '.env' file based on '.env.example'
cp .env.example .env

Transpile and run the project

# Development mode
pnpm run start;

# Watch mode
pnpm run start:dev;

# Production mode
pnpm build;
pnpm run start:prod;

Run tests

# Unit tests
pnpm run test

# E2E tests
pnpm run test:e2e

# Test coverage
pnpm run test:cov

Documentation

Given the default port (3005) for running the application, the API documentation is available at localhost:3005/docs

TO-DO

A few improvements to be considered for the next iterations of the application:

• Authentication
• Pagination
• Caching
• Configuration through ConfigModule, to be injected where needed
• Implementation of fields like created_at and deleted_at throughout all entities for better auditing
• Increase test coverage

License

Nest is MIT licensed.