From 5cb0624c0ca8e6223ad70aabe93d47bed49fcdeb Mon Sep 17 00:00:00 2001 From: Bill He Date: Mon, 6 Nov 2023 10:30:47 -0800 Subject: [PATCH] Add Env var descriptions to readme --- .env.example | 10 +++++++--- README.md | 14 ++++++++++++++ 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/.env.example b/.env.example index 6071abb..d7b105d 100644 --- a/.env.example +++ b/.env.example @@ -4,7 +4,11 @@ VITE_ALCHEMY_API_KEY= VITE_PK_ENCRYPTION_KEY= -VITE_WALLETCONNECT2_PROJECT_ID= - VITE_V3_TOKEN_ADDRESS=0x6d5bb505a4f85c10b122ccc36e30f57e2b86a291 -VITE_TOKEN_MIGRATION_URI=https://bridge.dydx.trade/ \ No newline at end of file +VITE_TOKEN_MIGRATION_URI=https://bridge.dydx.trade/ + +AMPLITUDE_API_KEY= +BUGSNAG_API_KEY= +IOS_APP_ID= +INTERCOM_APP_ID= +STATUS_PAGE_SCRIPT_URI= diff --git a/README.md b/README.md index 08ba6ef..f2cd4bc 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,20 @@ You'll need to provide a Wallet Connect project id to enable onboarding and wall - Create a project on https://cloud.walletconnect.com/app - Copy over the project ID into this [field](https://github.com/dydxprotocol/v4-web/blob/67ecbd75b43e0c264b7b4d2d9b3d969830b0621c/public/configs/env.json#L822C33-L822C46) +## Part 4: Set Enviornment variables +Set environment variables via `.env`. + +- `VITE_BASE_URL` (required) the base url of the deployment (e.g https://www.example.com) +- `VITE_ALCHEMY_API_KEY` (optional) Add an Alchemy API Key for evm interactions, app will fallback to public RPCs if not provided +- `VITE_PK_ENCRYPTION_KEY` (required) AES encryption key used for signature obfuscation, need for enabling "Remember Me" feature. +- `VITE_V3_TOKEN_ADDRESS` (required) Address of the V3 $DYDX token +- `VITE_TOKEN_MIGRATION_URI` (required) the URL of the token migration website +- `AMPLITUDE_API_KEY` (optional) Amplitude API Key for enabling Amplitude, used with `pnpm run build:inject-amplitude` +- `BUGSNAG_API_KEY` (optional) API Key for enabling bugsnap, used with `pnpm run build:inject-bugsnag` +- `IOS_APP_ID` (optional) IOS APP ID used for enabling deeplinking to the IOS APP, used with `pnpm run build:inject-app-deeplinks` +- `INTERCOM_APP_ID` (optional) used for enabling intercom, used with `pnpm run build:inject-intercom` +- `STATUS_PAGE_SCRIPT_URI` (optional) used for enabling status page, used with `pnpm run build:inject-statuspage` + # Deployments ## Deploying with Vercel