# nestjs-jump-start > A quick boiler plate for Nest JS application Latest version **1.0.0** (published 2024-02-06) · MIT license · 0 weekly downloads ## Install ```sh npm install nestjs-jump-start pnpm add nestjs-jump-start yarn add nestjs-jump-start bun add nestjs-jump-start ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.0 | | Published | 2024-02-06 | | First published | 2024-02-06 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 19 | | Unpacked size | 79.6 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Author | Jayant Chauhan | | Maintainers | iamjayantchauhan | | Keywords | nestjs, nest, nest-js-starter, nest-js-boilerplate, nodejs-framework, nodejs, nest-starter, nest-boilerplate | ## Links - npm: https://www.npmjs.com/package/nestjs-jump-start - Repository: https://github.com/iamjayantchauhan/nestjs-jump-start - Homepage: https://github.com/iamjayantchauhan/nestjs-jump-start#readme - Issues: https://github.com/iamjayantchauhan/nestjs-jump-start - npm.io page: https://npm.io/package/nestjs-jump-start ## Dependencies (19) - [rxjs](https://npm.io/package/rxjs.md) ^7.8.1 - [bcrypt](https://npm.io/package/bcrypt.md) ^5.1.1 - [winston](https://npm.io/package/winston.md) ^3.11.0 - [@nestjs/jwt](https://npm.io/package/@nestjs/jwt.md) ^10.2.0 - [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^10.0.0 - [nest-winston](https://npm.io/package/nest-winston.md) ^1.9.4 - [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^10.0.0 - [@nestjs/config](https://npm.io/package/@nestjs/config.md) ^3.1.1 - [@nestjs/swagger](https://npm.io/package/@nestjs/swagger.md) ^7.2.0 - [class-validator](https://npm.io/package/class-validator.md) ^0.14.1 - [@nestjs/mongoose](https://npm.io/package/@nestjs/mongoose.md) ^10.0.2 - [@nestjs/terminus](https://npm.io/package/@nestjs/terminus.md) ^10.2.1 - [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13 - [class-transformer](https://npm.io/package/class-transformer.md) ^0.5.1 - [http-status-codes](https://npm.io/package/http-status-codes.md) ^2.3.0 - [winston-cloudwatch](https://npm.io/package/winston-cloudwatch.md) ^6.2.0 - [@nestjs-modules/mailer](https://npm.io/package/@nestjs-modules/mailer.md) ^1.10.3 - [@nestjs/platform-express](https://npm.io/package/@nestjs/platform-express.md) ^10.0.0 - [mongoose-unique-validator](https://npm.io/package/mongoose-unique-validator.md) ^4.0.0 ## Alternatives - [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads - [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads - [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads - [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads - [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads ## Recent versions - 1.0.0 (latest) — 2024-02-06 ## README # Nest Boilerplate Welcome to the Nest Boilerplate project! This is a boilerplate template designed to kickstart your development with NestJS, a powerful and extensible Node.js framework. Whether you are building a small API or a complex microservices architecture, this starter provides a solid foundation and best practices to help you get started quickly ## Features - Modular Structure: Follows a modular architecture to organize your code into reusable and maintainable modules. - Dependency Injection: Leverages NestJS's built-in dependency injection system for better code organization and testability. - Database Integration: Includes support for popular database MongoDB - Authentication: Implements a basic authentication system using JWT (JSON Web Tokens). - Swagger Documentation: Automatic API documentation using Swagger UI for easy testing and exploration. - Testing: Unit and integration tests set up using Jest for ensuring code reliability. - Environment Variables: Utilizes environment variables for configuration to enhance flexibility. - Logging: Integrated logging with Winston for better debugging and monitoring. ## Installation Clone this repository: ``` git clone https://github.com/your-username/nest-js-starter.git ``` Install dependencies: ``` npm install ``` Set up your environment variables by creating a .env file based on .env.example. Choose and configure your preferred database settings in the configuration files. Run the application: ``` npm run start:dev ``` Access the Swagger documentation at http://localhost:3000/api/docs to explore the API. ## Commands There are couple of Commands already pre-configured for different purposes. Following are few of them. Command | Description | --- | --- | build | Triggers the production build | start | Start the project locally | start:dev | Start the project with DEV mode | start:debug | Start the project with DEBUG mode | start:prod | Start the project with PROD mode | format:check | Will check the code format | format:write | Changes the format to match with required format | lint:check | Lint check | lint:write | Write the lint changes | test | Run test cases | test:watch | Run tests with watch mode enabled | test:cov | Run tests with coverage | test:debug | Run test cases in debug mode | ## Authors - [@iamjayantchauhan](https://github.com/iamjayantchauhan) ## License [MIT](https://choosealicense.com/licenses/mit/) ## Contribution Contributions are welcome! If you have ideas for improvements or new features, feel free to open an issue or submit a pull request. Happy coding with Nest JS Starter! 🚀 --- _Source: https://npm.io/package/nestjs-jump-start · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._