Skip to content

readytowork-org/nestjs-todo-backend

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

Recommended Folder Structure

src/
├── main.ts                          # Application entry point
├── app.module.ts                    # Root module of the application
├── modules/                         # Feature modules
│   ├── todos/                       # Todo feature module
│   │   ├── dto/                     # Data Transfer Objects for todos
│   │   ├── entities/                # Todo entity definitions
│   │   ├── repositories/            # Repository layer for todos
│   │   ├── todos.controller.ts      # Controller for todos
│   │   ├── todos.service.ts         # Service for todos
│   │   ├── todos.module.ts          # Module definition
│   │   └── tests/                   # Unit and integration tests
│   ├── auth/                        # Authentication module
│   │   ├── dto/
│   │   ├── strategies/              # Passport strategies
│   │   ├── guards/                  # Authentication guards
│   │   ├── auth.controller.ts
│   │   ├── auth.service.ts
│   │   └── auth.module.ts
│   └── users/                       # User module
│       ├── dto/
│       ├── entities/
│       ├── repositories/
│       ├── users.controller.ts
│       ├── users.service.ts
│       └── users.module.ts
├── common/                          # Shared resources
│   ├── decorators/                  # Custom decorators
│   ├── filters/                     # Exception filters
│   ├── guards/                      # Global guards
│   ├── interceptors/                # Global interceptors
│   ├── interfaces/                  # Common interfaces
│   ├── middleware/                  # Custom middleware
│   ├── pipes/                       # Custom pipes
│   └── logger/                      # Custom logger implementation
├── config/                          # Configuration
│   ├── database.config.ts           # Database configuration
│   ├── app.config.ts                # App configuration
│   └── validation.schema.ts         # Configuration validation
├── core/                            # Core functionality
│   ├── database/                    # Database related code
│   ├── exceptions/                  # Custom exceptions
│   └── utilities/                   # Common utility functions
└── prisma/                          # Prisma service and client
    ├── prisma.module.ts
    └── prisma.service.ts

Description

Nest framework TypeScript starter repository.

Project setup

$ pnpm install

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published