From 9d7ffaabf95156731fb325b0a200c881adffead8 Mon Sep 17 00:00:00 2001 From: Chris Williams Date: Wed, 28 Mar 2018 16:09:26 -0700 Subject: [PATCH] add vx development section --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 6d8d6da85..2e683e663 100644 --- a/README.md +++ b/README.md @@ -219,6 +219,38 @@ Lots coming soon, check out the [roadmap](./ROADMAP.md). > Me too. +## Development +[lerna](https://github.com/lerna/lerna/) is used to manage versions and dependencies between +packages in the umbrella vx repo. + +``` +vx/ + lerna.json + package.json + packages/ + vx-package-1/ + src/ + test/ + build/ + package.json + ... + vx-package-2/ + ... + ... +``` + +For easiest development clone or fork vx, install the _root_ dependencies including lerna, +then have lerna install package dependencies and manage the symlinking between packages for you by using the [`lerna bootstrap`](https://github.com/lerna/lerna#bootstrap) command: + +```sh +git clone git@github.com:hshoff/vx.git # or your fork +cd vx +npm install # installs root vx deps +lerna bootstrap # installs all package deps, sym-links within-vx deps +``` + +Upon modification of a given package you can run `npm run build` from that package's folder to re-build the package with your changes. You can use the local dev server within `packages/vx-demo` to view and iterate on your changes in the gallery. From the `packages/vx-demo` folder run `npm run dev` to start the next server which (if correctly sym-linked with lerna) will also watch for changes you make to other packages. + :v: [MIT](./LICENSE) • [@hshoff](https://twitter.com/hshoff)