tscoverage/docs/getstarted.md

41 lines
968 B
Markdown
Raw Normal View History

2017-07-31 12:36:33 +00:00
---
name: Get Started
description: learn how to quickly write npm TypeScript modules
---
2017-07-31 12:36:33 +00:00
# Get Started with NPMTS
2017-07-31 12:36:33 +00:00
and learn how to quickly write npm TypeScript modules
## Step1: Install the tools
To use npmts install it using npm or yarn:
2017-07-31 12:43:50 +00:00
```sh
2017-07-31 12:36:33 +00:00
npm install -g npmts # install with npm
yarn global add npmts # install with yarn
```
For the purpose of getting started quickly please also install **gitzone**.
It'll proovide awesome scaffolding for new npmts maintained modules and also updates them later on.
2017-07-31 12:36:33 +00:00
2017-07-31 12:43:50 +00:00
```sh
2017-07-31 12:36:33 +00:00
npm install -g gitzone # install with npm
yarn global add gitzone # install with yarn
```
You can make sure npmts and gitzone are installed correctly by typing `npmts -v && gitzone -v`.
## Scaffold a new module
To scaffold a new module type
```shell
gitzone template npm
```
This will run you through a series of question to get gitzone to know the specifics of your module.
Enter all information accordingly.
## Run NPMTS for the first time