Skip to content

Repository files navigation

Nest Logo

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

NPM Version Package License NPM Downloads CircleCI Discord Backers on Open Collective Sponsors on Open Collective Donate us Support us Follow us on Twitter

Description

Nest framework TypeScript starter repository.

Project setup

$ npm install

Compile and run the project

# 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

License

Nest is MIT licensed.

Docker Deployment (AlmaLinux VPS)

The project includes a docker-compose.yml that provisions:

  1. NestJS Backend
  2. PostgreSQL 15
  3. Redis 7
  4. MinIO (S3-compatible storage, replacing Cloudinary and Backblaze)

Running on the VPS

  1. SSH into your VM and navigate to the project root.
  2. Edit your .env file to configure MinIO credentials (they replace Backblaze/Cloudinary):
    # Remove Cloudinary variables (CLOUDINARY_*)
    
    # Update Storage variables to point to MinIO
    BB_ENDPOINT=http://minio:9000
    BB_ACCESS_KEY_ID=admin
    BB_SECRET_ACCESS_KEY=admin12345
    BB_BUCKET_NAME=ieee-storage
    BB_REGION=us-east-1
    
    # Set Database and Redis for Docker
    DATABASE_URL=postgresql://postgres:password@postgres:5432/ieeecusb
    REDIS_HOST=redis
    REDIS_PORT=6379
    REDIS_PASSWORD=""
  3. Run the stack:
    docker-compose up -d --build

MinIO Console is available on port 9001 (login with admin / admin12345). The NestJS backend is exposed on port 3000.

Releases

Packages

Contributors

Languages