This is a starter repository for building efficient and scalable server-side applications using the NestJS framework and TypeScript. It provides a simple structure for rapid development and experimentation.
- Install dependencies:
npm install- Configure environment variables:
- Copy
.env.exampleto.envand adjust values as needed. - See the Configuration Guide for details.
- Run the application:
npm run start| Script | Description |
|---|---|
| npm run build | Compile the TypeScript source code |
| npm run clean | Remove build output and temporary files |
| npm run lint | Run ESLint to check code quality |
| npm run format | Format code using Prettier |
| npm run format:check | Check code formatting without changing files |
| npm run start | Start the application (development) |
| npm run start:dev | Start in watch mode |
| npm run start:prod | Start in production mode |
| npm run test | Run unit tests |
| npm run test:e2e | Run end-to-end tests |
| npm run test:cov | Run test coverage |
├── src/ # Main application source code
│ ├── app.controller.ts # App controller
│ ├── app.controller.spec.ts # App controller tests
│ ├── app.module.ts # App module
│ ├── app.service.ts # App service
│ ├── main.ts # Application entry point
│ └── config/ # Configuration-related code
│ └── configuration.ts # Configuration loader
├── test/ # End-to-end tests
│ ├── app.e2e-spec.ts # E2E test spec
│ └── jest-e2e.json # Jest E2E config
├── .env.example # Example environment variables
├── package.json # Project metadata and scripts
├── tsconfig.json # TypeScript configuration
├── nest-cli.json # NestJS CLI configuration
├── README.md # Project documentation
├── .github/ # GitHub Actions workflows and settings
└── docs/ # Project documentation
├── configuration-guide.md # Configuration guide
└── devops-guide.md # DevOps guide
For all guides and references—including configuration, Docker, DevOps, and API documentation—see the Documentation Table of Contents.
For more information, see the NestJS Documentation.