CHANGEME

Setup

Node

1. Install nvm (Node Version Manager)
2. cd to the project directory and execute the following:

   nvm install
   nvm use
   npm install
   

IDE Setup

This project uses EditorConfig for IDE configuration.

See .editorconfig for settings.

Many popular IDEs and editors support this out of the box or with a plugin.

Development

Prettier

This project uses Prettier, so please run it before checking in:

npm run pretty

See .prettierrc for settings.

Some IDEs and editors have plugins for running Prettier.

Linting

This project uses TSLint. Check linting before checking in:

npm run lint

See tslint.json for settings.

Many IDEs and editors support TSLint.

Testing

This project uses Jest for testing. Run tests before checking in.

Unit Tests

npm test

Integration Tests

npm run test:integration

Building

npm run build

Contracts

Setting up Rinkby

This isn't necessary for local deployment, but eventually you'll want to test on a semi-real test network.

1. Create an account at Infura

2. Create a new mnemonic with the following command:

   npx mnemonics

3. Create a secrets file at secrets.json with the following structure:

   {
     "mnemonic": "some great words ...",
     "mnemonicProd": "some better words ...",
     "projectId": "12345abcde",
     "projectSecret": "abcde12345"
   }

Build and deploy

npx oz create