MCluck90 / ts-node-project

Boilerplate for building a TypeScript app for Node.js

TypeScript Project

Boilerplate for a project built in TypeScript and running in Node.js.

Getting Started

1. Degit the repo

npx degit MCluck90/ts-node-project#main

2. Search for and replace the following:

   1. ts-node-project
   2. <YEAR>
   3. <COPYRIGHT HOLDER>
   4. <DESCRIPTION>
   5. <AUTHOR>

3. The integrated terminal is set to "cmd" to get around an issue with using Git Bash. If you don't use Git Bash, remove this setting.

Usage

Run the application

$ npm start

Development

This application is setup for debugging within VS Code. If you are not using VS Code or would prefer to just use the command line you can use the following command to run in watch mode:

$ npm run dev

Run tests

$ npm test

Build for production

$ npm run build