diff --git a/README.md b/README.md index 3c410a8..9e649f6 100755 --- a/README.md +++ b/README.md @@ -11,14 +11,8 @@ ## Setting up * install [npm](https://www.npmjs.com/get-npm) * install typescript globally (`npm i -g typescript`). This is important because it is needed to transcompile, so you can run your changes locally (using command `tsc`) +* run `npm install` * download the braid repo into a folder in the same directory as the primary yardstick folder -* `vagrant up` in the primary yardstick folder -* run the command `compose stop braid && compose rm braid && tsc && compose build braid && compose up -d` - * `compose stop` stops the default braid container that `vagrant up` builds - * `compose rm braid` removes the default braid container - * `tsc` transpiles the typescript in braid into javascript - * `compose build braid` builds the braid container based on the latest transpiled javascript files - * `comopose up -d` builds the braid container based on the files in the braid folder, overriding the defaul braid build container ## Building to Docker Hub * run `./build` @@ -35,6 +29,13 @@ braid: * once complete and confirmed to function, create a new PR for the measure repo, with the new tag and await ultimate judgement ## Local Development +* `vagrant up` in the primary yardstick folder +* run the command `compose stop braid && compose rm braid && tsc && compose build braid && compose up -d` in the braid folder + * `compose stop` stops the default braid container that `vagrant up` builds + * `compose rm braid` removes the default braid container + * `tsc` transpiles the typescript in braid into javascript + * `compose build braid` builds the braid container based on the latest transpiled javascript files + * `comopose up -d` builds the braid container based on the files in the braid folder, overriding the defaul braid build container * you can see if braid is running by typing in `https://ysbraid.localhost:8443` * to connect to braid you need to use the url `wss://ysbraid.localhost:8443?token={token}` * the token is generated in the application that you're connecting to the braid app with (currently only measure has an implementation for this)