diff options
author | Fabio Berger <me@fabioberger.com> | 2018-04-09 16:14:25 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-04-09 16:14:25 +0800 |
commit | 919b327fc534e3c2dc6330130cee690f0fa39fea (patch) | |
tree | fd58793bcd44f0c50e143f8f07c359e444ec34ee /packages/migrations/README.md | |
parent | e05b55d4a5698d3e936e7164ed69d9417d12cd12 (diff) | |
download | dexon-sol-tools-919b327fc534e3c2dc6330130cee690f0fa39fea.tar.gz dexon-sol-tools-919b327fc534e3c2dc6330130cee690f0fa39fea.tar.zst dexon-sol-tools-919b327fc534e3c2dc6330130cee690f0fa39fea.zip |
Move migrations into separate monorepo subpackage and hook it up to 0x.js and contracts
Diffstat (limited to 'packages/migrations/README.md')
-rw-r--r-- | packages/migrations/README.md | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/packages/migrations/README.md b/packages/migrations/README.md new file mode 100644 index 000000000..15129ae85 --- /dev/null +++ b/packages/migrations/README.md @@ -0,0 +1,69 @@ +## Migrations + +Migrate the 0x system of smart contracts on the network of your choice using these migrations. + +## Contributing + +We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. + +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. + +### Install dependencies + +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: + +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies + +```bash +yarn install +``` + +### Build + +If this is your **first** time building this package, you must first build **all** packages within the monorepo. This is because packages that depend on other packages located inside this monorepo are symlinked when run from **within** the monorepo. This allows you to make changes across multiple packages without first publishing dependent packages to NPM. To build all packages, run the following from the monorepo root directory: + +```bash +yarn lerna:rebuild +``` + +Or continuously rebuild on change: + +```bash +yarn dev +``` + +You can also build this specific package by running the following from within its directory: + +```bash +yarn build +``` + +or continuously rebuild on change: + +```bash +yarn build:watch +``` + +### Clean + +```bash +yarn clean +``` + +### Lint + +```bash +yarn lint +``` + +### Migrate + +In order to migrate the 0x smart contracts to TestRPC/Ganache running at `http://localhost:8545`, run: + +```bash +yarn migrate +``` |