Starter template for NestJS.
- GraphQL w/ playground
- Code-First w/ decorators
- Prisma for database modelling, migration and type-safe access (Postgres, MySQL & MongoDB)
- JWT authentication w/ passport-jwt
- REST API docs w/ Swagger
Install Nestjs CLI to start and generate CRUD resources
npm i -g @nestjs/cli
Install the dependencies for the Nest application:
npm install
Setup a development PostgreSQL with Docker. Copy .env.example and rename to .env
- cp .env.example .env
- which sets the required environments for PostgreSQL such as POSTGRES_USER
, POSTGRES_PASSWORD
and POSTGRES_DB
. Update the variables as you wish and select a strong password.
Start the PostgreSQL database
docker-compose -f docker-compose.db.yml up -d
# or
npm run docker:db
Prisma Migrate is used to manage the schema and migration of the database. Prisma datasource requires an environment variable DATABASE_URL
for the connection to the PostgreSQL database. Prisma reads the DATABASE_URL
from the root .env file.
Use Prisma Migrate in your development environment to
- Creates
migration.sql
file - Updates Database Schema
- Generates Prisma Client
npx prisma migrate dev
# or
npm run migrate:dev
If you like to customize your migration.sql
file run the following command. After making your customizations run npx prisma migrate dev
to apply it.
npx prisma migrate dev --create-only
# or
npm run migrate:dev:create
If you are happy with your database changes you want to deploy those changes to your production database. Use prisma migrate deploy
to apply all pending migrations, can also be used in CI/CD pipelines as it works without prompts.
npx prisma migrate deploy
# or
npm run migrate:deploy
Prisma Client JS is a type-safe database client auto-generated based on the data model.
Generate Prisma Client JS by running
Note: Every time you update schema.prisma re-generate Prisma Client JS
npx prisma generate
# or
npm run prisma:generate
Execute the script with this command:
npm run seed
Run Nest Server in Development mode:
npm run start
# watch mode
npm run start:dev
Run Nest Server in Production mode:
npm run start:prod
GraphQL Playground for the NestJS Server is available here: http://localhost:3000/graphql
Open up the example GraphQL queries and copy them to the GraphQL Playground. Some queries and mutations are secured by an auth guard. You have to acquire a JWT token from signup
or login
. Add the accessToken
as followed to HTTP HEADERS in the playground and replace YOURTOKEN
here:
{
"Authorization": "Bearer YOURTOKEN"
}
RESTful API documentation available with Swagger.
Nest server is a Node.js application and it is easily dockerized.
See the Dockerfile on how to build a Docker image of your Nest server.
Now to build a Docker image of your own Nest server simply run:
# give your docker image a name
docker build -t <your username>/nest-prisma-server .
# for example
docker build -t nest-prisma-server .
After Docker build your docker image you are ready to start up a docker container running the nest server:
docker run -d -t -p 3000:3000 --env-file .env nest-prisma-server
Now open up localhost:3000 to verify that your nest server is running.
When you run your NestJS application in a Docker container update your .env file
- DB_HOST=localhost
# replace with name of the database container
+ DB_HOST=postgres
# Prisma database connection
+ DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DB_HOST}:${DB_PORT}/${POSTGRES_DB}?schema=${DB_SCHEMA}&sslmode=prefer
If DATABASE_URL
is missing in the root .env
file, which is loaded into the Docker container, the NestJS application will exit with the following error:
(node:19) UnhandledPromiseRejectionWarning: Error: error: Environment variable not found: DATABASE_URL.
--> schema.prisma:3
|
2 | provider = "postgresql"
3 | url = env("DATABASE_URL")
You can also setup a the database and Nest application with the docker-compose
# building new NestJS docker image
docker-compose build
# or
npm run docker:build
# start docker-compose
docker-compose up -d
# or
npm run docker
Update the Prisma schema prisma/schema.prisma
and after that run the following two commands:
npx prisma generate
# or in watch mode
npx prisma generate --watch
# or
npm run prisma:generate
npm run prisma:generate:watch
The schema.graphql is generated with code first approach from the models, resolvers and input classes.
You can use class-validator to validate your inputs and arguments.
To implement the new query, a new resolver function needs to be added to users.resolver.ts
.
@Query(returns => User)
async getUser(@Args() args): Promise<User> {
return await this.prisma.client.user(args);
}
Restart the NestJS server and this time the Query to fetch a user
should work.