@lapidist/safestart
v1.3.1
Published
A TypeScript safe start with testing, versioning, coverage, docs and linting set up for you.
Downloads
3
Readme
safestart
safestart: A TypeScript boilerplate with testing, versioning, coverage, docs and linting set up for you.
Quickstart
Clone repository into a directory:
➜ git clone https://github.com/brettdorrans/safestart.git
Install dependencies:
➜ npm i
Find more information about package.json
scripts:
➜ npm run info
info:
Display information about the package scripts
build:
Clean and rebuild the project
fix:
Try to automatically fix any linting problems
test:
Lint and unit test the project
watch:
Watch and rebuild the project on save, then rerun relevant tests
cov:
Rebuild, run tests, then create and open the coverage report
doc:
Generate HTML API documentation and open it in a browser
Additional build tasks can be found in package.json
.
Credits and collaboration
safestart
is maintained by Brett Dorrans. I welcome comments, feedback and suggestions. Please feel free to raise an issue or pull request.
License
safestart
is licensed under the MIT license. See LICENSE.md for the full text.