CONTRIBUTING.md

environment

I use nvm to manage my node versions, and yarn as my package manager and build tool.

• on mac

brew install nvm
brew install yarn

development setup

• create a fork of the repo, clone that, and install the things

nvm install
yarn

• build it

yarn build

• you can now use the cli after configuring your .env

./cli extract <spaceKey>
./cli build <spaceKey>
./cli build <spaceKey> --serve # with webpack dev server

• or you can also run with local data

./cli build public --dest local --serve --open

run visual regression tests

yarnd wdio

house-keeping

• format the code

yarn format

• ensure license header is included in any new files contributed

yarn lint --fix