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

Description

Nest framework TypeScript starter repository.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Running locally on you workstation

# Requirements
## using a PostGreSQL instance locally
### for example 
$ docker run --rm -it --name canelbdd -p 5432:5432 -e POSTGRES_USER=user1 -e POSTGRES_PASSWORD=test123 -e POSTGRES_DB=canelbdd -d postgres

## Prepare environment file 
$ copy .env.example .env
### modifiy your variables in the .env file
#### for example on the file 
> DATABASE_URL="postgresql://user1:test123@localhost:5432/postgres?schema=public"
> TEST_DATABASE_URL="postgresql://user1:test123@localhost:5432/postgres?schema=public"
> VALIDATION_DAYS=730
> ROLE_VALIDATION_DAYS=730

# launch the service API locally 
$ npm install

## Insert the DB schema
$ npx prisma generate
$ npx prisma db push    
## Launch the service
$ npm run dev

# You can see the swagger on your navigator from url : http://localhost:3000/api

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

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.