diff options
Diffstat (limited to 'packages/react-docs-example/README.md')
| -rw-r--r-- | packages/react-docs-example/README.md | 32 |
1 files changed, 29 insertions, 3 deletions
diff --git a/packages/react-docs-example/README.md b/packages/react-docs-example/README.md index 7b2547b20..c7dfcd3aa 100644 --- a/packages/react-docs-example/README.md +++ b/packages/react-docs-example/README.md @@ -20,10 +20,22 @@ Then install dependencies yarn install ``` -#### Start the dev server +### Initial setup + +The **first** time you work with this package, you must 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 +PKG=0x.js yarn build +``` + +Note: If you move this package out of the monorepo, it will work without this step. Make sure you copy it out on the `master` branch since the `development` version might rely on not-yet published changes to other packages. + +### Run dev server + +The the `react-docs-example` root directory, run: ```bash -yarn dev +PKG=0x.js yarn watch ``` ### Deploy Example to S3 bucket @@ -38,8 +50,22 @@ yarn deploy_example ### Build +To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: + +```bash +PKG=@0xproject/react-docs-example yarn build +``` + +Or continuously rebuild on change: + +```bash +PKG=@0xproject/react-docs-example yarn watch +``` + +### Clean + ```bash -yarn build +yarn clean ``` ### Lint |