Skip to content
This repository has been archived by the owner on Feb 10, 2021. It is now read-only.

mpppk/ts-hifive-boilerplate

Repository files navigation

TypeScript + hifive boilerplate

Greenkeeper badge CircleCI codebeat badge codecov

GitLab Badges

build status coverage report

Installation

$ git clone https://github.com/mpppk/ts-hifive-boilerplate.git
$ npm install

Usage

Start server for development

$ npm start

npm start serve your application on http://localhost:8080 and updates the browser on changes.

Ref

Testing

$ npm test

npm test execute the test of __tests__/**/*.ts and output the coverage.

Ref

Linting

$ npm run lint

npm run lint execute linting.

Ref

Generate Documentation

$ npm run doc

npm run doc generate documentation to docs/.

Ref

Docker

$ docker build -t tshifive .
$ docker run -it -p 8080:8080 tshifive
# Now your application is served on http://localhost:8080

Tools

  • editorconfig
  • prettier

SaaS Integration

Circle CI

https://codecov.io

GitLab Integration

  • GitLab CI & Coverage