Replay is a new debugger for recording and replaying software. Debugging with Replay should be as simple as viewing print statements and more powerful than pausing with breakpoints. Of course, debugging should be collaborative as well!

Feel free to file any issues you see while recording or replaying.

Replay's DevTools is a React app built on top of the Replay protocol. Make sure to install nvm.

Note: We use Yarn 3 for package management - make sure you have Yarn installed globally first: npm i -g yarn

Getting started is as simple as:

# Setup environment variables
cp .env.sample .env

# Install dependencies
nvm use
yarn install

# Run dev server (see below)

To run DevTools locally, paired with the production Dashboard project:

yarn dev:prod

At this point DevTools will be accessible at localhost:8080 and will proxy any library or authentication requests to the production deployment of the Dashboard project.

To run both the DevTools and Dashboard projects locally:

# DevTools (this project)
yarn dev:local

# Dashboard
pnpm dev:local

At this point the Dashboard will be accessible at localhost:8080 but it will not load recordings. To be able to test the end-to-end interaction of both apps, use localhost:8081. It will serve both Dashboard and DevTools routes.

Next, download and install the Replay browser. The browser will allow you to start recording your own replays.

Everybody's welcome to join us on Discord, but please read through our Community Etiquette guidelines first.

Anyone is welcome to contribute to the project! If you're just getting started we recommend you start by reading the contributing guide and then check out the "good first issues". If you have questions you can ask in the in the #development channel. (Please do not "@" or direct message people with questions though!)

To run the end-to-end tests make sure that devtools is running locally on port 8080 and run:

cd packages/e2e-tests

yarn test

If you want to run the tests against a local build of the browser, you'll need to invoke the tests like so:

RECORD_REPLAY_PATH=~/devel/gecko-dev/rr-opt/dist/Replay.app RECORD_REPLAY_BUILD_PATH=~/devel/gecko-dev node test/run.js

Replace the paths with the appropriate paths to and within gecko-dev as appropriate in your environment.

If you want to run the tests against a local build of the backend, you'll need to invoke the tests like so:

RECORD_REPLAY_SERVER=ws://localhost:8000 RECORD_REPLAY_DRIVER=~/devel/backend/out/macOS-recordreplay.so node test/run.js

Replace the paths with the appropriate paths within the backend repo as appropriate in your environment.

yarn lint checks the code with ESLint, Prettier and Stylelint, as the Lint workflow does on every pull request. yarn lint:fix fixes what they can fix automatically, including formatting.

See /src/graphql/README.md for details.

Every commit to the main branch is automatically deployed to production.