Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First Time Setup Documentation: Update Readme with env vars and their use #283

Open
codecakes opened this issue Aug 17, 2022 · 0 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@codecakes
Copy link
Contributor

We do not current have enough documentation on the number of environment variables we use and why, in the readme for first timers.

Here are the initial env vars we use:

REACT_APP_GOOGLE_MAPS_API_KEY # Use to call maps api from google to render maps and places.
REACT_APP_UBER_CLIENT_ID # used for calling uber functions for navigation
REACT_APP_COOKIEBOT_SRC # used for cookie consent and tracking on our production website.
REACT_APP_COOKIEBOT_CONSENT_DECLARATION # a cookie bot consent src code that renders the declaration modal which allows users to select/deselect which cookies they consent to.
REACT_APP_COOKIEBOT_CONSENT_HEAD = "https://consent.cookiebot.com/uc.js"
REACT_APP_COOKIEBOT_CONSENT_HEAD_DATA_CBID # cookiebot header data. another id from cookiebot
REACT_APP_ESP_PROXY_DOMAIN # a proxy load balancer domain address. Not needed for now.
REACT_APP_ESP_PROXY_PORT # Port for a proxy load balancer domain address. Not needed for now.
REACT_APP_AUTH0_CLIENT_ID # auth0 client id for making the auth0 login functionality work
REACT_APP_AUTH0_DOMAIN # auth0 domain value

The following are firebase api credentials in order to work with firebase calls.
----------------------------------------
REACT_APP_FIREBASE_API_KEY 
REACT_APP_FIREBASE_APP_ID 
REACT_APP_FIREBASE_AUTH_DOMAIN
REACT_APP_FIREBASE_DB_URL 
REACT_APP_FIREBASE_MEASUREMENT_ID
REACT_APP_FIREBASE_MSG_SENDER_ID
REACT_APP_FIREBASE_PROJECT_ID 
REACT_APP_FIREBASE_STORAGE_BUCKET

It would be good to have these documented in our README

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

2 participants