Since this file will be changed, please see docs/template for documentation.
Use an LTS-version of Node.js or later. This was developed in node=v11.6.0 and npm=6.5.0
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.
-
npm install -
Run platform specific start script (
npm startornpm start:win)
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