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

testing details, spelling, and grammar

Browse Source
This commit is contained in:
brmnjsh 2019-03-14 16:39:16 -04:00 committed by GitHub
parent 31b597f385
commit 78cfb530c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,12 +1,11 @@
# BRAID v0.8.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) [![Build Status](https://semaphoreci.com/api/v1/projects/7767f0f3-4da6-4c84-9167-4db5402a3262/2573412/badge.svg)](https://semaphoreci.com/yardstick/braid)
## Essential Information: ## 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. * 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) * 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 ## Local Development
* 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`
@ -31,9 +30,10 @@ payload = {
token = JWT.encode payload, hmac_secret, "HS256" token = JWT.encode payload, hmac_secret, "HS256"
``` ```
* to test your changes before pushing you can run `compose test`
## Setting up ## 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 * `vagrant up` in the primary yardstick folder
* run the command `compose stop braid && compose rm braid && tsc && compose build braid && compose up -d` * 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 stop` stops the default braid container that `vagrant up` builds