BRAID v1.3.1
Websocket server for the Measure platform
Essential Information:
- braid uses mocha (test framework), chai (BDD/TDD assertion library), sinnon (spies, stubs, and mocks), nyc (code coverage calculator) for our unit testing. Get aquainted with these packages to have a smooth unit testing experience.
- for schema management/validation, braid uses joi.
- For web sockets braid uses ws
- braid uses 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
- install npm
- install typescript globally (
npm i -g typescript). This is important because it is needed to transpile, so you can run your changes locally (using commandtsc) - run
npm install - download the braid repo into a folder in the same directory as the primary yardstick folder
- 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