Notes API

Description

Nest backend REST API for a notes application, with NestJS, Prisma, PostgreSQL and Swagger

Techs

Tools to build this application:

• NestJS as the backend framework
• Prisma as the Object-Relational Mapper (ORM)
• PostgreSQL as the database
• Swagger as the API documentation tool
• TypeScript as the programming language

Project setup

$ yarn install

Compile and run the project

# development runs in http://localhost:3000/api/
$ yarn run start

# watch mode
# Swagger will be running on /api
$ yarn run start:dev

# production mode
$ yarn run start:prod

DB related

# apply migrations, generate Prisma Client and seed the database
npx prisma migrate dev

# seed
npx prisma db seed

Run tests

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

License

Nest is MIT licensed.