Go to file

jshbrmn c2e4310a25 Update README.md		2024-04-24 13:46:15 -04:00
.docker-compose	remove explicit port	2020-01-30 14:59:25 -05:00
certs	https, max send size	2019-02-28 23:21:06 -05:00
src	rm CustomChannel	2023-08-01 17:41:16 +00:00
.dockerignore	First commit	2019-02-27 12:16:34 -05:00
.gitignore	new gitignore and cleaning up dev comments	2019-03-14 17:08:11 -04:00
.vagrantrc	integrating basic websocket	2019-02-28 17:49:46 -05:00
Dockerfile	remove explicit port	2020-01-30 14:59:25 -05:00
Jenkinsfile	Feature/dev 13474 kaniko braid (#24 )	2022-03-16 14:06:16 -05:00
Makefile	update makefile	2020-02-21 16:46:47 -05:00
README.md	Update README.md	2024-04-24 13:46:15 -04:00
docker-compose.override.yml	First commit	2019-02-27 12:16:34 -05:00
docker-compose.yml	remove explicit port	2020-01-30 14:59:25 -05:00
docker_tag.txt	version bump	2023-08-01 17:46:58 +00:00
package-lock.json	`npm i` bumped packages	2023-08-01 17:41:06 +00:00
package.json	version bump	2023-08-01 17:46:58 +00:00
rc	generlize everything	2019-12-19 23:20:39 -05:00
tsconfig.json	integrating basic websocket	2019-02-28 17:49:46 -05:00

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

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
clone the braid repo