From a920ae3dfc71220ebdf6ac23f0d09c08b7f2f10a Mon Sep 17 00:00:00 2001 From: Joshua Burman Date: Sat, 8 Feb 2025 21:09:31 -0800 Subject: [PATCH] Update README.md --- README.md | 24 ------------------------ 1 file changed, 24 deletions(-) diff --git a/README.md b/README.md index 3d88711..fcc0a09 100755 --- a/README.md +++ b/README.md @@ -15,29 +15,5 @@ * install typescript globally (`npm i -g typescript`). This is important because it is needed to transpile, 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 - -## Building to Docker Hub (**this has been retired, new methodolgy will be outlined soon**) -* run `./build` -* when complete you'll see something like this `Your new docker tag: yardstick/braid:tagid` -* copy this tag id, and in the yardstick `docker-compose.yml` file change the `image` field to have the new tag, for example: -``` -braid: - image: yardstick/braid:{add the new tag here} - environment: - VIRTUAL_HOST: ysbraid.localhost - HTTPS_METHOD: noredirect -``` -* 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 image based on the latest transpiled javascript files - * `comopose up -d` starts the braid container based on the files in the braid folder, overriding the default braid build container -* you can see if braid is running by typing in `https://ysbraid.localhost` -* to connect to braid you need to use the url `ws://ysbraid.localhost` * to test your changes before pushing you can run `tsc && npm test` * to check code coverage run `nyc npm test`, we must maintain above 90% code coverage