A template repository for Node TypeScript projects. Includes TypeScript, Jest for testing, and Prettier for formatting. Configures TS and Jest with sensible, basic defaults; does not modify Prettier's preset formatting opinions. Has been tested with Node 16, 18, and 20.
| Command | Description |
|---|---|
npm run build |
removes prior build from /dist folder, then runs the TypeScript compiler (tsc) on the /src directory and outputs JS files to the /dist folder |
npm run start |
starts the app with an entry point of dist/main.js (it assumes the /dist folder has already been built) |
npm run dev |
builds and starts the app, then watches for changes, rebuilds as-needed, and restarts the app when changes are detected |
npm run test |
runs the test files in the project |
npm run test:watch |
runs the test files in the project and watches for changes; reruns tests on changes |
npm run fix |
runs the Prettier formatter on the project, writes formatting changes to files |
Includes a GitHub Actions workflow to confirm the basics are working; you will likely want to delete or edit this directory to suit your own needs.
Documentation for options you may want to change: