braid/README.md
2025-02-08 21:09:31 -08:00

1.7 KiB
Executable File

BRAID v1.3.1

Websocket server for the Measure platform

Build Status Maintainability

Essential Information:

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 command tsc)
  • 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