pujitm / ts-starter

A TypeScript starter that is flexible and testable. For both Node and the Web

ts-starter

Since this file will be changed, please see docs/template for documentation.

Prerequisites

Use an LTS-version of Node.js or later. This was developed in node=v11.6.0 and npm=6.5.0

Basic Information

All source files in src are compiled to <project root>/bin

Each directory under src should be mapped under the "_moduleAliases" key in package.json. This enables absolute imports.

Module resolution (post-compile) via module-alias

Paths for absolute imports in Typescript are defined in tsconfig.json.

Getting Started

• npm install

• Run platform specific start script (npm start or npm start:win)

Testing

This repo uses AVA for testing and c8 for coverage (feel free to change to nyc).

Documentation for other testing frameworks is under docs/template/testing