https://github.com/mastermunj/typescript-boilerplate
TypeScript Boilerplate for Node.js Projects
https://github.com/mastermunj/typescript-boilerplate
boilerplate eslint jest nodejs prettier template typescript typescript-boilerplate
Last synced: 10 months ago
JSON representation
TypeScript Boilerplate for Node.js Projects
- Host: GitHub
- URL: https://github.com/mastermunj/typescript-boilerplate
- Owner: mastermunj
- License: mit
- Created: 2020-04-24T12:10:12.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T04:17:00.000Z (about 1 year ago)
- Last Synced: 2024-10-30T07:19:22.273Z (about 1 year ago)
- Topics: boilerplate, eslint, jest, nodejs, prettier, template, typescript, typescript-boilerplate
- Language: TypeScript
- Size: 6.34 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript Boilerplate for Node.js
## Features
* Latest & Greatest [TypeScript](https://github.com/Microsoft/TypeScript)
* [EsLint](https://github.com/eslint/eslint) & [Prettier](https://github.com/prettier/prettier) with recommended rules
* [Jest](https://github.com/facebook/jest) & [ts-jest](https://github.com/kulshekhar/ts-jest) for unit tests
* NPM scripts for build, lint, test & release
* [Commitlint](https://github.com/conventional-changelog/commitlint/) for ensuring [conventional commit format](https://www.conventionalcommits.org/)
* [Standard Version](https://github.com/conventional-changelog/standard-version) for easy release management using [semver](https://github.com/semver/semver)
* [GitHub Actions](https://github.com/features/actions) as CI
## How to Use?
1. Clone Repository
```sh
git clone git@github.com:mastermunj/typescript-boilerplate.git
```
2. Run `reset.sh`
```sh
cd
chmod +x reset.sh && ./reset.sh
```
The script does following:
* Removes remote origin
* Clears git commit history making the repo as good as fresh initiated
* Runs npm install
* Removes `reset.sh` file for safety