https://github.com/jessety/boilerplate-typescript-service
Boilerplate for a TypeScript Node service
https://github.com/jessety/boilerplate-typescript-service
boilerplate boilerplate-typescript-service ci editorconfig eslint github-actions github-releases template typescript typescript-boilerplate typescript-service typescript-template typescript-templates
Last synced: about 2 months ago
JSON representation
Boilerplate for a TypeScript Node service
- Host: GitHub
- URL: https://github.com/jessety/boilerplate-typescript-service
- Owner: jessety
- License: mit
- Created: 2020-10-23T13:52:07.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-17T20:48:22.000Z (over 2 years ago)
- Last Synced: 2025-05-07T20:42:02.148Z (about 2 months ago)
- Topics: boilerplate, boilerplate-typescript-service, ci, editorconfig, eslint, github-actions, github-releases, template, typescript, typescript-boilerplate, typescript-service, typescript-template, typescript-templates
- Language: Dockerfile
- Homepage:
- Size: 1020 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# boilerplate-typescript-service
Boilerplate for a TypeScript Node service
[](https://github.com/jessety/boilerplate-typescript-service/actions/workflows/ci.yml)
## Includes
- TypeScript configuration
- `ts-jest` setup for automated testing
- ESLint rules & `editorconfig` for linting
- Prettier and ESLint for deterministic code formatting
- CI - build, lint & test
- GitHub Releases generated with automatic changelogs populated via a configurable template
- Dependabot configuration
- VSCode settings
- Modern JS compilation target (native modules)
- PM2 ecosystem file
## Release
First, determine what kind of [semantic versioning](https://semver.org) bump this release will require. Updates should fall into one of three categories: `major` (new functionality with breaking changes) `minor` (new functionality without breaking changes) or `patch` (backwards compatible bug fixes).
To publish a new release, checkout the make sure your git repository is clean and run one of the following commands:
- `npm run release:major` (new functionality with breaking changes)
- `npm run release:minor` (new functionality without breaking changes)
- `npm run release:patch` (backwards compatible bug fixes)
Running any one of these will:
1. Increment the version number in `package.json` (and `package-lock.json` if available)
2. Create a git tag with the new version number
3. Push these changes to GitHub, which triggers the `release` workflow in GitHub Actions
4. The `release` workflow then creates a new GitHub release with changelog automatically populated with all PRs and commits since the last version