Using a GitHub template repo

In order to use this repo as a template, first create a new repo on GitHub by clicking on the "Use this template" button. This will create a new repo in your account (just as forking a repo does on GitHub). Then you can clone the repo and start working on it on your machine.

What does template give you?

This is a template project that makes it easy to work w/ Node.js w/ TypeScript and Jest projects. Make sure to run npm install before running the scripts or the IDEA Run Configurations shown below.

npm scripts

You can run the following npm scripts:

1. npm run start - This runs main.ts
2. npm run test - This runs all the Jest tests.

✨ Note there is no build script, because this project uses tsm in order to quickly compile and run TypeScript files using Node.js.

IDEA Run Configurations

You can also use IDEA Run Configurations that are included.

1. Run all tests - This runs all the tests in Jest (using ts-jest).
2. main.ts - This uses Node.js w/ tsm to run the src/main.ts file.
3. The following npm scripts are provided.
4. Run the tests (test).
5. Watch all the tests running (test-watch).
6. Run the main.ts file (start).
7. Run the linter (lint).

How do I get changes made to this template in the future?

Here are the steps to create a remote called template. When there are changes to this repo, you can pull the changes from and then merge those changes into main.

git remote add template https://github.com/nazmulidris/ts-node-dev-template
git pull template main

💡 You can get more info on this topic here.