Eventshuffle backend API exercise

Description

This repository is my submission for the Eventshuffle backend API exercise. The solution is build by using Nest framework.

Running the application

Setup database

Start PostgreSQL database with Docker Compose or start PostgreSQL 14 on host and set connection details with DATABASE_URL environment variable.

$ docker compose up -d postgres --build

Without Docker

# use Node.js 14 LTS version
$ npm install

# development
$ npm run start

# or watch mode
$ npm run start:dev

# or debug mode
$ npm run start:debug

# or production mode
$ npm run build
$ npm run start:prod

# navigate to http://localhost:3000/

With Docker

Start API backend and database services.

$ docker compose up -d --build

# navigate to http://localhost:3000/

Test

$ npm install

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Tools

Prisma Studio is a tool for exploring and manipulating database data.

npm run studio

Compodoc is a tool for generating project documentation.

npm run compodoc