Skip to content
This repository was archived by the owner on Apr 23, 2024. It is now read-only.

demo app

Fabio Russo edited this page Sep 17, 2021 · 7 revisions

The demo app can be run either locally with

npm run start

to run the node/express server

and

npm run start-demo

to run the frontend site (by default on localhost:3003)

if you're having trouble running it on windows you can explicitly set the port in the npm command for "start-demo" and make it look like this:

set PORT=3003 && react-scripts start

In order to get a deployable package simply run:

npm run build

and then deploy e.g. (heroku)

git push heroku main

the package will run as expected since express will be serving the react demo app as a static page.

The demo app looks like this:

You can simply paste in your API Key and it will stick around until you need it.

Things to configure in your example app

There are some constants that require you to have environment variables, you can see that because there's a process.env in front of them. These are supposed to be things like API Keys that are your own and should not go on a git repository. You'll recognize what you need e.g. Sentry or Bugsnag constants. Of course feel free to remove any integration that you don't actively need from the code to make it work the way you want it to. And of course this is only meant to be an example of how to implement the fullstack apis on your backend.

How to use this example app

Just run an extension recording on the url you deployed this sample app to and hit the "Send" button a couple of times during an extension recording. The extension will generate a unique recording uuid and send it along in the request headers to your example site, the test_send method will extract the uuid from the header and send it along to the actual "Send" call to the BugReplay FullStack API Layer. You can then see the results in your report video in the "Server Logs" tab.

Clone this wiki locally