PaaSTech Client API

Description

PaaSTech API's Nest framework TypeScript repository.

Installation

$ npm install

Development

First, copy .env.example into your own .env file and replace all appropriate values.

WARNING: There should be no need to replace the given defaults, which are already fully configured to use in development mode.

To run the application, you will need to use the Docker Compose in the root folder:

$ docker compose up -d

After this, you will need to run once:

# generates prisma's client for TS types and classes
$ npx prisma generate

# applies the migrations to the database
$ npx prisma migrate deploy

If you need to generate migrations after editing the schema.prisma file, you can run:

$ npx prisma migrate dev --name "name of your migration here"

Optionally, you may also seed the database.

This will add two users with the password specified in your .env file. For more details, checkout prisma/seed.ts

$ npx prisma db seed

Mailhog (the mail development server) is reachable through localhost:8025 on the web once the docker compose has been upped.

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov