sbracegirdle/ts-template

Typescript NodeJS project template and boilerplate

Simon's Typescript Template

Opinionated template for creating Typescript-based Nodejs projects. Useful for TS-based scripts, web servers, lambda functions etc.

Includes configurations for:

• Language; typescript (including ts-node)
• Linting (pre-commit); eslint
• Formatting (pre-commit); prettier, husky
• Unit testing; mocha, chai, sinon
• Feature testing; cucumber-js
• Dependency maintenance; npm-check, npm audit
• NPM script tools; npm-run-all
• Bundling; webpack, ts-loader

Installation and pre-requisites

Recommended NodeJS 12+

git clone git://github.com/sbracegirdle/ts-template.git my-project
cd my-project
rm -rf ./git
npm install

How to run locally

npm run start

How to test

npm run test

How to lint

npm run lint

How to build

npm run build

Check dependencies

Checks for vulnerabilities (npm audit) and out of date packages (npm-check).

npm run check

Upgrade dependencies

npm run upgrade

License

MIT License