Skip to content

Files

Latest commit

0b74c5f · Jan 26, 2024

History

History
97 lines (72 loc) · 3.73 KB

README.md

File metadata and controls

97 lines (72 loc) · 3.73 KB

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

Description

This is a simple api built using nestjs, prisma, postgres and docker using the Nest framework TypeScript starter repository.

Installation

$ npm install

Launching the Postgres Database locally

docker-compose up -d

add this key value pair to your .env file

DATABASE_URL="postgresql://postgres:password@localhost:5432/nestapi?schema=public"

Apply the initial migration

npx prisma migrate dev

Seed database using prisma

npm run prisma:seed

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Visit the swagger at

http://localhost:3000/api

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.