35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
## Development
|
|
This project supports both `*.js` files written in ES6 Javascript as well as `*.ts` files written in TypeScript. All get transpiled to ES5 Javascript.
|
|
|
|
|
|
###Project structure
|
|
|
|
```
|
|
src/main: All project source files
|
|
src/test: All project test source files
|
|
|
|
build/main: All transpiled source files
|
|
build/test: All transpiled test source files
|
|
|
|
package.json: NPM Project dependencies
|
|
typings.json: Type definitions dependencies for TypeScript
|
|
```
|
|
|
|
###Get Started
|
|
`typings` is a convenient tool that helps to manage the project's type definition dependencies (*.d.ts files). These help TypeScript and the developer understand and provide autocompletion assistance with many common javascript frameworks such as `node`, `mocha`, and `chai`. The project type dependencies are stored in `typings.json`.
|
|
|
|
To install the `typings` tool, execute:
|
|
|
|
```
|
|
yarn install -g typings
|
|
```
|
|
|
|
Then to install all dependencies of the project (including the typings type definitions), execute:
|
|
|
|
```
|
|
yarn install
|
|
```
|
|
|
|
###Gulping
|
|
The project supports many useful gulp targets such as `es6`, `ts` (transpiling the respective source types) or `transpile` for both. We also support `clean`, `test`, `watch`, `devwatch` and more.
|