This is a template for TypeScript projects using Node. It uses TypeScript for strict typing and compiling into JavaScript and Nodemon to automatically refresh the build when changes are made. It's set up to use ESLint for linting and Prettier for formatting.
To get started, clone this repository and run yarn install
or npm install
to install the dependencies.
The information in package.json
should be changed to reflect the details of your project.
The following scripts are available:
yarn build
ornpm run build
- Compiles the TypeScript files into JavaScript.yarn start
ornpm run start
- Runs the compiled JavaScript files.yarn dev
ornpm run dev
- Runs the TypeScript files directly using Nodemon.yarn lint
ornpm run lint
- Runs ESLint on the TypeScript files.yarn format
ornpm run format
- Runs Prettier on the TypeScript files.yarn release:<major|minor|patch>
ornpm run release:<major|minor|patch>
- Formats and build the project then bumps the version number and creates a Git tag.