Skip to content

FireBlinkLTD/node-ts-project-template

Repository files navigation

Node.js TypeScript project template generator

CircleCI Greenkeeper badge

Allow to generate TypeScript based Node.js project with:

  • TS, JSON, YAML, Git Commit Message lints
  • Mocha TypeScript scaffolding with test coverage reporting
  • [Optionaly] initialized git repository and initial commit
  • [Optionaly] initialized Dockerfile and docker-compose.yml
  • [Optionaly] initialized CircleCI configuration

Usage

First, install FBL.

npm install -g fbl

Then generate your new project with single command:

fbl https://github.com/FireBlinkLTD/node-ts-project-template/archive/master.tar.gz

You can also pass all the options into command itself to avoid answering prompts:

fbl \
 -a \$.ctx.name=@scope/name \
 -a \$.ctx.description=Super\ Plugin \
 -a \$.ctx.author=FireBlinkLTD \
 -a \$.ctx.license=MIT \ 
 -a \$.ctx.destination=/path/to/project_dir \
 -a \$.ctx.git.init=true \
 -a \$.ctx.git.commit=true \
 -a \$.ctx.docker=true \
 https://github.com/FireBlinkLTD/node-ts-project-template/archive/master.tar.gz