From 78cfb530c0985f5dbeb81d14c8c9b1fbc3aaeb10 Mon Sep 17 00:00:00 2001 From: brmnjsh Date: Thu, 14 Mar 2019 16:39:16 -0400 Subject: [PATCH 1/5] testing details, spelling, and grammar --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2f4098f..b2bc08a 100755 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ # BRAID v0.8.5 ## Websocket server for the Measure platform ---- [![Build Status](https://semaphoreci.com/api/v1/projects/7767f0f3-4da6-4c84-9167-4db5402a3262/2573412/badge.svg)](https://semaphoreci.com/yardstick/braid) ## Essential Information: * braid uses [mocha (test framework)](https://www.npmjs.com/package/mocha), [chai (BDD/TDD assertion library)](https://www.npmjs.com/package/chai), [sinnon (spies, stubs, and mocks)](https://www.npmjs.com/package/sinon), [nyc (code coverage calculator)](https://www.npmjs.com/package/nyc) for our unit testing. Get aquainted with these packages to have a smooth unit testing experience. * 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 benifitsm drawbacks and dev flow +* 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 ## Local Development * you can see if braid is running by typing in `https://ysbraid.localhost:8443` @@ -31,9 +30,10 @@ payload = { token = JWT.encode payload, hmac_secret, "HS256" ``` +* to test your changes before pushing you can run `compose test` ## Setting up -* download the braid repo into a folder in the same director 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 From b9e008caf341538dd7da2ce9b4fc661bc1f261e9 Mon Sep 17 00:00:00 2001 From: brmnjsh Date: Thu, 14 Mar 2019 16:40:01 -0400 Subject: [PATCH 2/5] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b2bc08a..f451cfc 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # BRAID v0.8.5 -## Websocket server for the Measure platform +> Websocket server for the Measure platform [![Build Status](https://semaphoreci.com/api/v1/projects/7767f0f3-4da6-4c84-9167-4db5402a3262/2573412/badge.svg)](https://semaphoreci.com/yardstick/braid) ## Essential Information: @@ -17,7 +17,8 @@ secret = "test" payload = { :data => { - :client => 'client name (mhs is only one implemented currently)', :client_type => 'site (only one in use rite now)', + :client => 'client name (mhs is only one implemented currently)', + :client_type => 'site (only one in use rite now)', :user_id => (yardstick user id), :user_type => '(teacher/user)', :channel => 'desired channel name' From 91512e29e5d1519fffdd75eba1fc2df938d241eb Mon Sep 17 00:00:00 2001 From: brmnjsh Date: Thu, 14 Mar 2019 16:41:04 -0400 Subject: [PATCH 3/5] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f451cfc..3e033fd 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # BRAID v0.8.5 > Websocket server for the Measure platform + [![Build Status](https://semaphoreci.com/api/v1/projects/7767f0f3-4da6-4c84-9167-4db5402a3262/2573412/badge.svg)](https://semaphoreci.com/yardstick/braid) ## Essential Information: From 918b4014f2de07f4b1ca0d79b5dcffa722a473e5 Mon Sep 17 00:00:00 2001 From: brmnjsh Date: Thu, 14 Mar 2019 16:48:54 -0400 Subject: [PATCH 4/5] Update README.md --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3e033fd..af821ec 100755 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ payload = { token = JWT.encode payload, hmac_secret, "HS256" ``` -* to test your changes before pushing you can run `compose test` +* 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 @@ -43,3 +43,17 @@ token = JWT.encode payload, hmac_secret, "HS256" * `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 From 698ff96f1f1ebe7e8b6710cc26c024ac0d4804bf Mon Sep 17 00:00:00 2001 From: brmnjsh Date: Thu, 14 Mar 2019 16:49:41 -0400 Subject: [PATCH 5/5] 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