The Backstroke dashboard interacts with the api to provide a simple management interface for Backstroke links.
- Yarn is used to manage dependencies - run
yarn
to download all dependencies of the dashboard. - Run
yarn start
to start the development server, courtesy of Create React App. - To make a production build, run
yarn build
. The build will be outputted into abuild/
folder created in the root of the repo. Th make a clean build, remove thebuild/
folder prior to building.
When developing, press bang-bang-grave-space in quick succession (bang = !, grave = `). This opens
a small modal that lets the user choose an environment to point the system to (locally, production,
staging, or something else). One option is the environment variable REACT_APP_API_URL
. This
setting persists in localStorage
between page reloads.
REACT_APP_APP_URL
: The path to this project. In production, this ishttps://app.backstroke.co
.REACT_APP_API_URL
: The path to the api that this project interacts with. In production, this ishttps://api.backstroke.co
.REACT_APP_ROOT_URL
: The path to the main site. In production, this ishttps://backstroke.co
.REACT_APP_MIXPANEL_TOKEN
: An optonal mixpanel token to use for tracking dashboard usage.REACT_APP_SENTRY_DSN
: An optonal sentry DSN to use when reporting errors.