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

Description

Nest framework TypeScript starter repository.

Project setup

🐳 Docker setup

The project is setup to run with docker and docker-compose. The project is composed of the following services:

• Backend: NestJS application
• Database: Postgres database

Prerequisites

• Docker
• Docker Compose
• Create a .env file in the root of the project and add the following variables
  • Database variables:

    - POSTGRES_USER=admin
    - POSTGRES_PASSWORD=admin
    - POSTGRES_DB=wytnessdb
    - POSTGRES_PORT=5432
    - POSTGRES_HOST=localhost

• Backend variables:

    - PORT=<Choose a port for the backend>
    - DATABASE_URL=DATABASE_URL="postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@$POSTGRES_HOST:$POSTGRES_PORT/$POSTGRES_DB?schema=public"

• Firebase variables : CF How to get the google firebase credentials

    - TYPE=<Type>
    - PROJECT_ID=<Project ID>
    - PRIVATE_KEY_ID=<Private Key ID>
    - PRIVATE_KEY=<Private Key>
    - CLIENT_EMAIL=<Client Email>
    - CLIENT_ID=<Client ID>
    - UTH_URI=<Auth URI>
    - TOKEN_URI=<Token URI>
    - AUTH_CERT_URL=<Auth Cert URL>
    - CLIENT_CERT_URL=<Client Cert URL>
    - UNIVERSAL_DOMAIN=<Universal Domain>
    - API_KEY=<API Key>

Use the following command to start the project with docker

$ docker-compose up --build

Or use the detached mode :

$ docker-compose up --build -d

🔧 Manual setup

If you dont want to use docker, you can setup the project manually by following the steps below.

$ 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 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.

How to get the google firebase credentials

1. Go to the Firebase Console.
2. Click on the gear icon and go to Project Settings.
3. Go to the Service Accounts tab.
4. Click on the Generate New Private Key button to download a JSON file with your service account credentials.
5. Save the JSON file in the root of the project and rename it to firebase-credentials.json.
6. Add the following environment variables to your .env file.

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.