| 1 | # VAMTIGER Node Typescript Project
|
| 2 | [VAMTIGER Node Typescript Project](https://github.com/vamtiger-project/vamtiger-node-typescript-project) initializes a [node.js](https://nodejs.org/en/) [typescript](https://www.typescriptlang.org/) project by:
|
| 3 | - Inititialising the current working directory as a repository
|
| 4 | - Creating a **_source_** branch for development
|
| 5 | - Defining a boilerplate **_manifest_**
|
| 6 | <br>
|
| 7 | <br>
|
| 8 | <img src=https://cdn.rawgit.com/vamtiger-project/vamtiger-node-typescript-project/abdef842/asset/image/vamtiger-node-typescript-project.svg style="max-height: 350px; background-color: #f0f0f0; border-radius: 3px" width=400>
|
| 9 |
|
| 10 | ## Installation
|
| 11 | [VAMTIGER Node Typescript Project](https://github.com/vamtiger-project/vamtiger-node-typescript-project) can be installed using [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/lang/en/):
|
| 12 | ```javascript
|
| 13 | npm i --global vamtiger-node-typescript-project
|
| 14 | ```
|
| 15 | or
|
| 16 | ```javascript
|
| 17 | yarn global vamtiger-node-typescript-project
|
| 18 | ```
|
| 19 |
|
| 20 | ## Usage
|
| 21 | [VAMTIGER Node Typescript Project](https://github.com/vamtiger-project/vamtiger-node-typescript-project) initializes a [node.js](https://nodejs.org/en/) [typescript](https://www.typescriptlang.org/) in the current working directory:
|
| 22 | ```json
|
| 23 | vamtigerNodeTypescriptProject
|
| 24 | # or
|
| 25 | vamtiger-node-typescript-project
|
| 26 | ```
|