node-ts-starter-template
TypeScript icon, indicating that this package has built-in type declarations

1.5.3 • Public • Published

node-ts-starter-template

starter template for nodejs development with Typescript, eslint and more

Codacy Badge code style: prettier Coverage Status GitHub Pages GitHub npm

Get up to speed with nodejs development using this template with useful libraries and config:

  • typescript
  • ts-jest
  • eslint
  • airbnb
  • commitlint
  • husky
  • prettier
  • coveralls
  • vscode
  • travis
  • typedoc
  • github pages

Installation

  1. Clone from here
  2. Initialze your new repository: npm run setup

Test

npn run test

Enable Github Pages docs site

This template supports generating api documentation using TypeDoc.

It you want to host this on a Github pages site you need to create a specific branch for that:

  • git checkout --orphan gh-pages
  • git rm -rf .
  • git commit --allow-empty -m "Init empty branch"
  • git push origin gh-pages

More info can be found here: https://medium.com/linagora-engineering/deploying-your-js-app-to-github-pages-the-easy-way-or-not-1ef8c48424b7

Also, if you want to deploy the documentation with Travis change this in the .travis.yml file:

  • uncomment the npm run docs command
  • uncomment the pages provider task

Package Sidebar

Install

npm i node-ts-starter-template

Weekly Downloads

11

Version

1.5.3

License

MIT

Unpacked Size

7.16 kB

Total Files

6

Last publish

Collaborators

  • jaspenlind