From 698ff96f1f1ebe7e8b6710cc26c024ac0d4804bf Mon Sep 17 00:00:00 2001 From: brmnjsh Date: Thu, 14 Mar 2019 16:49:41 -0400 Subject: [PATCH] Update README.md --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index af821ec..bd43756 100755 --- a/README.md +++ b/README.md @@ -8,6 +8,30 @@ * For web sockets braid uses [ws](https://www.npmjs.com/package/ws) * braid uses [typescript](https://www.npmjs.com/package/typescript) for our primary code development because of it's opinionated type management among other things. Get a good understanding of what typescript is, it's benifits, drawbacks, and dev flow +## Setting up +* 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` +* when complete you'll see something like this `Your new docker tag: yardstick/micro-services:braid-tagid` +* copy this tag id, and in the yardstick `docker-compose.yml` file change the `image` field to have the new tage, for example: +``` +braid: + image: yardstick/micro-services:braid-{add the new tag here} + environment: + VIRTUAL_HOST: ysbraid.localhost + HTTPS_METHOD: noredirect + VIRTUAL_PORT: 8443 +``` +* once complete and confirmed to function, create a new PR for the measure repo, with the new tag and await ultimate judgement + ## Local Development * 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}` @@ -33,27 +57,3 @@ token = JWT.encode payload, hmac_secret, "HS256" ``` * to test your changes before pushing you can run `npm test` - -## Setting up -* 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` -* when complete you'll see something like this `Your new docker tag: yardstick/micro-services:braid-tagid` -* copy this tag id, and in the yardstick `docker-compose.yml` file change the `image` field to have the new tage, for example: -``` -braid: - image: yardstick/micro-services:braid-{add the new tag here} - environment: - VIRTUAL_HOST: ysbraid.localhost - HTTPS_METHOD: noredirect - VIRTUAL_PORT: 8443 -``` -* once complete and confirmed to function, create a new PR for the measure repo, with the new tag and await ultimate judgement