diff --git a/README.md b/README.md index e58f63183c8..dae7d55c4b9 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ ![](/public/images/logo.svg) -## Replay +# Replay 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! -### Issues +## Issues Feel free to file any issues you see while recording or replaying. -### Setup instructions: +## Getting started Replay's DevTools is a React app built on top of the Replay [protocol](https://www.notion.so/replayio/Protocol-d8e7b5f428594589ab60c42afad782c1). Make sure to install [nvm](https://github.com/nvm-sh/nvm#installing-and-updating). @@ -17,12 +17,15 @@ Replay's DevTools is a React app built on top of the Replay [protocol](https://w Getting started is as simple as: -``` -git clone git@github.com:RecordReplay/devtools.git -cd devtools +```sh +# Setup environment variables +cp .env.sample .env + +# Install dependencies nvm use yarn install -cp .env.sample .env + +# Run dev server (localhost:8080 by default) yarn dev ``` @@ -30,6 +33,19 @@ Once you see `Compiled succesfully` in your terminal, open your browser and go t **You just successfully opened your first Replay recording!** That recording uses your locally running copy of Replay DevTools to debug our test recording. + +### Local development + +To run both the DevTools and [Dashboard](https://github.com/replayio/dashboard) projects locally: + +```sh +# DevTools root (this project) +DASHBOARD_URL=http://localhost:8080 npm exec next dev -- -p 8081 + +# Dashboard root +DEVTOOLS_URL=http://localhost:8081 pnpm dev -- -p 8080 +``` + ### Next steps Next, download and install the [Replay browser](https://www.replay.io/). The browser will allow you to start recording your own replays.