README.md

nestjs-open-source-template

This is a template for creating a new open source project in NestJS.

Features

• TypeScript
• Jest
• ESLint
• Prettier
• GitHub Actions
• Dependabot
• Semantic Release
• Commitizen
• Commitlint
• Conventional Commits
• Semantic Versioning

Usage

1. Click the "Use this template" button to create a new repository from this template.
2. Clone the new repository to your local machine.
3. Run npm install to install dependencies.
4. Replace name, description, and other fields in package.json with your own.
5. Replace the contents of this file with your own.
6. Replace name of package at github actions workflow file

Scripts

• npm run build - Compile TypeScript to JavaScript.
• npm run lint - Lint TypeScript files.
• npm run test - Run tests.
• npm run publish:npm - Publish package to npm.
• npm run publish:dev - Publish package to npm with dev tag.