https://github.com/fireblinkltd/node-ts-project-template
Node.js TypeScript project generator
https://github.com/fireblinkltd/node-ts-project-template
circleci docker fbl generator node template typescipt
Last synced: 26 days ago
JSON representation
Node.js TypeScript project generator
- Host: GitHub
- URL: https://github.com/fireblinkltd/node-ts-project-template
- Owner: FireBlinkLTD
- Created: 2019-02-28T08:25:18.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-04-03T16:54:35.000Z (about 6 years ago)
- Last Synced: 2025-03-15T03:13:30.609Z (about 1 year ago)
- Topics: circleci, docker, fbl, generator, node, template, typescipt
- Language: TypeScript
- Size: 157 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node.js TypeScript project template generator
[](https://circleci.com/gh/FireBlinkLTD/node-ts-project-template) [](https://greenkeeper.io/)
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](https://www.npmjs.com/package/fbl).
```bash
npm install -g fbl
```
Then generate your new project with single command:
```bash
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:
```bash
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
```