module-starter-typescript

Starter project for building Node.js modules with TypeScript

Getting started

1. Clone the repository:

git clone https://github.com/ceddybi/mts.git <name>

2. Edit fields on package.json:

{
  "name": "module-name",
  "repository": "module-repo",
  "author": "your-info"
  // ...
}

3. Install dependencies:

yarn install

4. Add your library code on src/ and tests on /test.

Scripts

All scripts are defined on the Makefile.

Compile TypeScript files:

make build

Lint files:

make lint

Run tests:

make test

Show coverage report:

make coverage

Remove auto-generated folders:

make clean

License

MIT © Ceddy Muhoza