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

Description

Nest framework TypeScript starter repository.

Project setup

$ npm install

Environment

This service supports separate local and production env files.

• Local development: .env.local
• Production: .env.production
• Templates: .env.local.example, .env.production.example, .env.example

The runtime chooses env files like this:

• NODE_ENV=production -> .env.production
• otherwise -> .env.local
• if DOTENV_CONFIG_PATH is set, it wins over both defaults

Database settings are read from environment variables:

• DB_HOST
• DB_PORT
• DB_USER
• DB_PASSWORD
• DB_NAME
• DB_SYNCHRONIZE

Auth

This service supports two auth modes:

• AUTH_MODE=session: server-side session stored in Redis (connect.sid cookie)
• AUTH_MODE=jwt: short-lived access token + refresh token cookie (/api/v1/auth/refresh)

Auth routes

The frontend talks to this service directly:

• POST /api/v1/auth/login
• POST /api/v1/auth/register
• POST /api/v1/auth/refresh
• GET /api/v1/auth/profile
• POST /api/v1/auth/google
• POST /api/v1/auth/logout

Google login

Add these env vars (typically in .env.local / .env.production):

• GOOGLE_CLIENT_ID (required): Google OAuth Web Client ID (must match VITE_GOOGLE_CLIENT_ID in the frontend)
• GOOGLE_AUTO_CREATE_USER (optional, default false): when true, a first-time Google login can auto-create a local user row

Endpoint:

• POST /api/v1/auth/google with JSON body { "credential": "<google_id_token>" }

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

For production Docker Compose deployments, prefer using .env.production as the source of the container environment.

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

$ npm install -g @nestjs/mau
$ mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

• Visit the NestJS Documentation to learn more about the framework.
• For questions and support, please visit our Discord channel.
• To dive deeper and get more hands-on experience, check out our official video courses.
• Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
• Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
• Need help with your project (part-time to full-time)? Check out our official enterprise support.
• To stay in the loop and get updates, follow us on X and LinkedIn.
• Looking for a job, or have a job to offer? Check out our official Jobs board.

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.