LaconicNetwork/dydx-v4-web
5
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity
release-workflow
dydx-v4-web/scripts
History
Bill a7bd6a3ee8
host amplitude script ourselves (#307) 
* host amplitude script ourselves

* update sha
2024-02-15 15:45:44 -08:00
..
inject-amplitude.js host amplitude script ourselves (#307) 2024-02-15 15:45:44 -08:00
inject-app-deeplinks.sh Add script to inject iOS app ID to public/.well-known/apple-app-site-association (#66) 2023-10-10 15:58:26 -07:00
inject-bugsnag.js Initial commit 2023-09-08 13:52:13 -07:00
inject-intercom.js Support Intercom (#92) 2023-10-20 16:30:22 -07:00
inject-smartbanner.js Feature/mob 162 smartbanner (#274) 2024-02-07 10:10:22 -08:00
inject-statuspage.js Initial commit 2023-09-08 13:52:13 -07:00
README.md Feature/mob 162 smartbanner (#274) 2024-02-07 10:10:22 -08:00
update-ipns.js Initial commit 2023-09-08 13:52:13 -07:00
upload-ipfs.js Initial commit 2023-09-08 13:52:13 -07:00

README.md

App Integrations

Amplitude

Analytics service used to collect data to help the dYdX Product team make informed product decisions.

To use with dydxprotocol/v4-web:

  1. Amplitude account with API key.
  2. Add API key in Github > Secrets and Variables > Actions as AMPLITUDE_API_KEY
  3. In your deploy scripts add pnpm run build:inject-amplitude after your pnpm build / vite build command.

Bugsnag

Error handling service used to collect handled/unhandled errors within the app. The information collected is used to help debug and alert the engineering team of crashes/unhandled errors within the app to improve stability.

To use with dydxprotocol/v4-web:

  1. Bugsnag account with API key.
  2. Add API key in Github > Secrets and Variables > Actions as BUGSNAG_API_KEY
  3. In your deploy scripts add pnpm run build:inject-bugsnag after your pnpm build / vite build command.
  4. If you are using with the Amplitude deployment scripts, your build command may look like the following: pnpm build && pnpm run build:inject-amplitude && pnpm run build:inject-bugsnag

StatusPage

Service used to inform users of any status updates to our platform. These status updates are manually set and updated by the On Call engineers.

To use with dydxprotocol/v4-web:

  1. StatusPage account and script URI
  2. Add API key in Github > Secrets and Variables > Actions as STATUS_PAGE_SCRIPT_URI
  3. In your deploy scripts add pnpm run build:inject-statuspage after your pnpm build / vite build command.
  4. If you are using with the Amplitude deployment scripts, your build command may look like the following: pnpm build && pnpm run build:inject-amplitude && pnpm run build:inject-statuspage

Intercom

Service used for live customer support (chat/inbox) as well as home for Help Articles.

To use with dydxprotocol/v4-web:

  1. Create Intercom account
  2. In Intercom UI Getting started > Set up Messenger > will give you your API Key on Step 2 Customize Intercom Messenger by adding logo and brand colors
  3. Add API key in Github > Secrets and Variables > Actions as INTERCOM_APP_ID
  4. In your deploy scripts add pnpm run build:inject-intercom after your pnpm build / vite build command.
  5. If you are using with the Amplitude deployment scripts, your build command may look like the following: pnpm build && pnpm run build:inject-amplitude && pnpm run build:inject-intercom

Smartbanner

Smartbanner to show download links to iOS and/or Android native apps on mobile devices.

To use with dydxprotocol/v4-web:

  1. iOS app App Store link or Android app Google Play link.
  2. Add configurations in Github > Secrets and Variables > Actions as SMARTBANNER_APP_NAME for app name SMARTBANNER_ORG_NAME for organization name SMARTBANNER_ICON_URL for icon image SMARTBANNER_APPSTORE_URL for iOS App Store link SMARTBANNER_GOOGLEPLAY_URL for Android Google Play link
  3. In your deploy scripts add pnpm run build:inject-smartbanner after your pnpm build / vite build command.
  4. If you are using with the Amplitude deployment scripts, your build command may look like the following: pnpm build && pnpm run build:inject-smartbanner