aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs-example
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-04-05 08:57:21 +0800
committerFabio Berger <me@fabioberger.com>2018-04-05 08:57:21 +0800
commitd76bc18bb7ccaa18f31df6e48722502e21610bdf (patch)
treefdd1f63efb8fe50797f5ebb788ab6b35cbd41f30 /packages/react-docs-example
parent674e56cea69fe96ddd0071d3c4c5b5ea8ae299bf (diff)
downloaddexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.gz
dexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.tar.zst
dexon-sol-tools-d76bc18bb7ccaa18f31df6e48722502e21610bdf.zip
Improve contributing section of all packages so they include building entire monorepo on first contribution
Diffstat (limited to 'packages/react-docs-example')
-rw-r--r--packages/react-docs-example/README.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/packages/react-docs-example/README.md b/packages/react-docs-example/README.md
index 7b2547b20..7eeade960 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
-yarn dev
+yarn lerna:rebuild
+```
+
+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 run dev
```
### Deploy Example to S3 bucket
@@ -42,6 +54,12 @@ yarn deploy_example
yarn build
```
+### Clean
+
+```bash
+yarn clean
+```
+
### Lint
```bash