## Pre-requisites

1.  We are using Node 8. If you need to work with multiple versions of Node, you
    might consider using [nvm](https://github.com/creationix/nvm).
1.  This repository uses [yarn](https://yarnpkg.com/) to manage node dependencies. Please install yarn globally using `npm install --global yarn`.
1.  This repository uses [typescript](https://www.typescriptlang.org/). Please install yarn globally using `yarn global add typescript ts-node`
1.  This repository uses [mocha](https://github.com/mochajs/mocha) to run tests. `yarn global add mocha`

## Typical workflow

You would only do this once after you cloned the repository.

1.  Clone this repository from git.
1.  `cd` into `steedos-core`.
1.  We develop on the `develop` branch and release from the `master` branch. At
    this point, you should do initiate a `git checkout -t origin/develop`.
1.  `yarn bootstrap` to bootstrap the packages in the current Lerna repo. Installs all of their dependencies and links any cross-dependencies.
1.  `yarn` to bring in all the top-level dependencies.
1.  Open the project in your editor of choice.

## List of Useful commands

### `yarn compile`

This compiles the typescript to javascript.

### `yarn clean`

This cleans all generated files and directories. Run `yarn cleal-all` will also clean up the node_module directories.

### `yarn test`

This tests the typescript using ts-node.

### `yarn lint`

This lists all the typescript. If there are no errors/warnings
from tslint, then you get a clean output. But, if they are errors from tslint,
you will see a long error that can be confusing – just focus on the tslint
errors. The results of this is deeper than what the tslint extension in VS Code
does because of [semantic lint
rules](https://palantir.github.io/tslint/usage/type-checking/) which requires a
tsconfig.json to be passed to tslint.