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

Description

Nest framework TypeScript starter repository.

API Documentation

Comprehensive API documentation is available in the docs/api/ directory:

• API Overview - General API information and conventions
• Question Paper Update API - Detailed guide for the question paper update system

Quick API Reference

The application provides RESTful APIs for managing question papers with the following key endpoints:

• GET /question-papers - List all question papers
• GET /question-papers/:id - Get a specific question paper
• POST /question-papers - Create a new question paper
• PATCH /question-papers/:id - Update question paper (supports 14 different update operations)
• DELETE /question-papers/:id - Delete a question paper
• POST /question-papers/generate-with-ai - Generate question papers using AI

All endpoints require Firebase authentication. See the API documentation for detailed usage examples and request/response formats.

Project setup

$ pnpm install

Development Container

This project includes a development container configuration that provides a consistent development environment. The dev container includes:

• Node.js 18 with pnpm package manager
• PostgreSQL database
• NestJS CLI pre-installed
• VS Code extensions and debugging configuration

Prerequisites

To use the development container, you need:

1. Docker installed on your machine
2. Visual Studio Code with the Remote - Containers extension installed

Getting Started with Dev Container

1. Open the project in VS Code
2. When prompted, click "Reopen in Container" or run the "Remote-Containers: Reopen in Container" command from the command palette
3. VS Code will build the container and set up the development environment
4. Once the container is running, you can start developing

For more details, see the .devcontainer/README.md file.

Compile and run the project

# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod

Run tests

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

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

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