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

Description

Nest framework TypeScript starter repository.

Project setup

$ npm install

Compile and run the project

Local Redis and Redis Insight

Set a strong REDIS_PASSWORD in the local .env file (which is ignored by Git), then start both services with Docker Desktop running:

REDIS_PASSWORD=replace-with-a-long-random-password
REDIS_URL=redis://default:replace-with-a-long-random-password@127.0.0.1:6379

The password in REDIS_URL must be URL-encoded if it contains special characters.

docker compose up -d

• Redis: 127.0.0.1:6379 (database 0, username default, password from .env). Redis requires authentication for commands. Compose refuses to start if REDIS_PASSWORD is missing or empty.
• Redis Insight: http://localhost:5540. The SimpleTable local connection is preconfigured and appears after the initial setup, including accepting the terms in the UI. If the UI asks for connection details, use host redis, port 6379, username default, and REDIS_PASSWORD from .env: Redis Insight connects from inside the Compose network.
• Both ports are bound to 127.0.0.1 for local development.
• Redis uses AOF persistence; Redis data and Redis Insight settings are stored in named Docker volumes and survive container recreation.

Useful commands:

docker compose ps
docker compose exec redis redis-cli ping
docker compose exec redis redis-cli
docker compose logs -f redis
docker compose stop
docker compose up -d
docker compose down

docker compose down preserves data. Adding --volumes deletes the data of both services.

When connecting the locally running NestJS backend, use the authenticated REDIS_URL from .env. Starting these containers alone does not enable caching or sessions in the backend.

To change the password, update both REDIS_PASSWORD and REDIS_URL in .env, run docker compose up -d, and restart the backend so it loads the new credentials. Redis Insight gets the password from Compose automatically; manually added connections may need their password updated in the UI. Data volumes are preserved.

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

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.