Development
You should be comfortable with Node.js, TypeScript and Rust and additionally with working within mono-repos.
The TracerBench GitHub Org is comprised of three primary mono-repos that make up the bulk of the implementation.
Which are:
-
tracerbench
- cli
- har
- har-remix
- stats
- tracerbench (core)
- chrome-debugging-client
- tracerbench-serve
Debugging
When debugging the tracerbench CLI it's especially helpful to leverage `--inspect-brk` prepended to a CLI command, eg.
NODE_OPTIONS= --inspect-brk node bin/run compare
Tests
To run the tests in the tracerbench mono-repo, run the following:
git clone https://github.com/TracerBench/tracerbench.git
...
cd tracerbench && yarn && yarn test
To run the tests in the chrome-debugging-client mono-repo, run the following:
git clone https://github.com/TracerBench/chrome-debugging-client.git
...
cd chrome-debugging-client && yarn && yarn test
To run the tests in the tracerbench-serve mono-repo, run the following:
# as of this writing, tracerbench-serve requires the latest rust beta
rustup toolchain install beta
git clone https://github.com/TracerBench/tracerbench-serve.git
...
cd tracerbench-serve && cargo test
License
TracerBench is licensed under a permissive BSD 2-clause license.