jshbrmn/braid
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
brmnjsh 2019-03-14 17:41:48 -04:00 committed by GitHub
parent 2bdffedce2
commit e9d10eba94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -11,14 +11,8 @@
## Setting up ## Setting up
* install [npm](https://www.npmjs.com/get-npm) * 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`) * 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 * 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 ## Building to Docker Hub
* run `./build` * 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 * once complete and confirmed to function, create a new PR for the measure repo, with the new tag and await ultimate judgement
## Local Development ## 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` * 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}` * 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) * the token is generated in the application that you're connecting to the braid app with (currently only measure has an implementation for this)