tip: this frontend is designed to work with a Flask-based backend. It is recommended you stand up the backend first, test using Postman and the test script, and then the frontend should integrate smoothly.
This project depends on Nodejs and Node Package Manager (NPM). Before continuing, you must download and install Node (the download includes NPM) from https://nodejs.com/en/download.
This project uses NPM to manage software dependencies. NPM Relies on the package.json file located in the frontend directory of this repository. After cloning, open your terminal and run npm install.
Secrets (such as private API keys) shouldn't be stored directly in your React app. For this reason, we use environment variables to setup app secrets such as your application's Auth0 ClientID. More information here.
Create a .env file in the frontend directory's root and include the following variables. Update the variables to match your Auth0 setup. All values will be provided on Auth0's dashboard.
REACT_APP_AUTH0_CLIENT_ID="your-auth0-application-client-id"
REACT_APP_AUTH0_DOMAIN="your-auth0-tenant-domain"
REACT_APP_AUTH0_API_AUDIENCE="your-auth0-custom-api-audience"
The frontend app was built using create-react-app. In order to run the app in development mode use npm start. After starting the server successfully, open http://localhost:3000 to view it in the browser. The page will reload automatically if you make edits.