This is a lightweight TypeScript boilerplate that uses jest for testing, prettier for formatting, and typedoc for document generation.
Delete or rename the existing src/HelloWorld.ts and src/HelloWorld.spec.ts files to reflect your preferred names.
npm run lint will compare your code against the linter settings. This repository is set to use tabs for indentation and single quotes for strings.
npm run test will run your tests. For a coverage report, use npm run test:coverage. And to have tests watch for changes and automatically re-run, use npm run test:watch.
Reach out to the maintainer at one of the following places:
First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
We have set up a separate document containing our contribution guidelines.
Thank you for being involved!
The original setup of this repository is by Russel Porosky.
For a full list of all authors and contributors, check the contributor's page.
TS-Boilerplate follows good practices of security, but 100% security can't be granted in software. TS-Boilerplate is provided "as is" without any warranty. Use at your own risk.
For more info, please refer to the security.
This project is licensed under the MIT license.
See LICENSE for more information.