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

Description

Nest framework TypeScript starter repository.

Project setup

$ yarn install

Compile and run the project

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Run tests

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn 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:

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

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.

Preparation

Init Postgresql

To install PostgreSQL and create the mydb database, follow these steps:

1. Install PostgreSQL:

# Update the package list
$ sudo apt update

# Install PostgreSQL
$ sudo apt install postgresql postgresql-contrib

2. Switch to the PostgreSQL user:

$ sudo -i -u postgres

3. Create a new database:

$ createdb mydb

Your PostgreSQL installation is now complete, and the mydb database has been created.

Example .env file

Create a .env file in the root of your project with the following content:

DATABASE_URL="postgresql://<USERNAME>:<PASSWORD>@localhost:5432/mydb?schema=public"

Init kafka

To initialize Kafka and start consuming messages, we use docker-compose to set up the Kafka environment. The following commands will help you get started:

1. Start the Kafka services using docker-compose:

$ sudo docker-compose up -d

2. Check the Kafka logs for any exceptions:

$ sudo docker logs <kafka-container-id> | grep -i 'exception'

3. List Kafka topics and consumer groups:

$ docker exec -it <kafka-container-id> /bin/bash
$ kafka-topics --bootstrap-server localhost:9092 --list
$ kafka-consumer-groups --bootstrap-server localhost:9092 --list

Example of create new task and create new submission

$ curl -X POST http://localhost:3456/task -H "Content-Type: application/json" -d '{"name": "M*N", "description": "Hello World"}'

$ curl -X POST http://localhost:3456/submission -H "Content-Type: application/json" -d '{"taskId": 2, "code": "print(1*2)"}'

Test backend

To test the backend, you can use the following command to create a new task environment:

$ curl -X POST http://localhost:3456/task-env/create -H "Content-Type: application/json" -d '{"name": "{taskEnvName}", "dockerImage": "{dockerImageContent}"}'
$ curl -X POST http://localhost:3456/task-env/build-image -H "Content-Type: application/json" -d '{"taskEnvName": "{taskEnvName}"}'

Replace {taskEnvName} and {dockerImageContent} with the appropriate values for your task environment.

For example:

$ curl -X POST http://localhost:3456/task-env/create -H "Content-Type: application/json" -d '{"name": "custom-a", "dockerImage": "FROM python:slim\nRUN pip install --no-cache-dir numpy\n"}'
$ curl -X POST http://localhost:3456/task-env/build-image -H "Content-Type: application/json" -d '{"taskEnvName": "custom-a"}'