typescript module boilerplate
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test
.editorconfig
.gitignore
.prettierrc
.travis.yml
Makefile
changelog.md
license
package.json
readme.example.md
readme.md
tsconfig.json
tslint.json
yarn.lock

readme.md

module-starter-typescript

Build Status coverage Node.js version Jest GNU Make

Starter project for building Node.js modules with TypeScript

Getting started

  1. Clone the repository:
git clone https://github.com/ruanmartinelli/module-starter-typescript.git <name>
  1. Edit fields on package.json:
{
  "name": "module-name",
  "repository": "module-repo",
  "author": "your-info"
  // ...
}
  1. Install dependencies:
yarn install
  1. 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 © Ruan Martinelli