@jknanda78/ts-node-boilerplate
v1.2.2
Published
boilerplate for ts based web applications
Readme
ts-boilerplate
Boilerplate npm modules to run Node.js TS applications
Usage
Command Line
Provide your project name
npx @jknanda78/ts-node-boilerplate <project-name>Development
Installation Steps
- Clone the repo
- Run
npm installfor installing dependencies - Run
npm linkto test the changes locally usingnpxcli.- Run
npx ts-boilerplate <folder-name>
- Run
Contributing
We use Semantic Versioning with automated releases via GitHub Actions. Please see CONTRIBUTING.md for:
- Conventional Commit Message guidelines
- Development workflow
- Branch management
Automated Release Process
Releases are automatically triggered when commits are merged to main:
- Feat commits → Minor version bump (1.x.0)
- Fix commits → Patch version bump (1.0.x)
- BREAKING CHANGE footer → Major version bump (x.0.0)
Just follow the commit conventions and GitHub Actions handles the rest!
Secrets Required
To enable automated npm publishing in GitHub Actions, add this secret to your repository:
NPM_TOKEN: Your npm authentication token (from https://npmjs.com)
