vega-frontend-monorepo/apps/token/README.md
botond a6a21bed46
Feat/427: Serve explicit environments (#433)
* feat: add env specific serve commands where appropriate for apps

* fix: typo in command call

* feat: add custom executor for serving apps

* chore: clean up project files and use the custom executor

* chore: patch readmes

* chore: split out logs into their own function

* fix: prevent overriding env when no flag passed in

* fix: add tsc to postinstall to take care of compiling the custom executors

* fix: remove the custom serve executor from trading
2022-05-23 10:56:11 +01:00

4.0 KiB

The Vega token website

Control panel for your VEGA tokens

Screenshot 2021-12-11 at 06 32 51

Features

  • View vesting progress
  • Redeem VEGA tokens
  • Stake VEGA tokens
  • Withdraw tokens
  • Vote on proposals

Development

Starting the app:

yarn nx serve token

Configuration

Example configurations are provided here:

For convenience, you can boot the app injecting one of the configurations above by running:

yarn nx run token:serve --env={env} # e.g. stagnet1

There are a few different configuration options offered for this app:

Flag Purpose
NX_APP_SENTRY_DSN The sentry endpoint to report to. Should be off in dev but set in live.
NX_APP_CHAIN The ETH chain for the app to work on. Should be mainnet for live, but ropsten for preview deploys.
NX_APP_VEGA_URL The GraphQL query endpoint of a Vega data node
NX_APP_DEX_STAKING_DISABLED Disable the dex liquidity page an show a coming soon message
NX_APP_FAIRGROUND Change styling to be themed as the fairground version of the website
NX_APP_INFURA_ID Infura fallback for if the user does not have a web3 compatible browser
NX_APP_HOSTED_WALLET_ENABLED If the hosted wallet is enabled or not. If so then allow users to login using the hosted wallet
NX_APP_ENV Change network to connect to. When set to CUSTOM use CUSTOM_* vars for network parameters
CUSTOM_URLS When NX_APP_ENV=CUSTOM use these Data Node REST URLs, optional if CUSTOM_URLS_WITH_GRAPHQL is used.
CUSTOM_URLS_WITH_GRAPHQL When NX_APP_ENV=CUSTOM use these Data Node GraphQL URLs, optional if CUSTOM_URLS is used.
CUSTOM_TOKEN_ADDRESS When NX_APP_ENV=CUSTOM specify Vega token address.
CUSTOM_CLAIM_ADDRESS When NX_APP_ENV=CUSTOM specify Vega claim address.
CUSTOM_LOCKED_ADDRESS When NX_APP_ENV=CUSTOM specify Vega locked address.
CUSTOM_VESTING_ADDRESS When NX_APP_ENV=CUSTOM specify Vega vesting address.
CUSTOM_STAKING_BRIDGE When NX_APP_ENV=CUSTOM specify Vega staking bridge address.

Example configs:

For example configurations, check out our netlify.toml.

Testing

To run the minimal set of unit tests, run the following:

yarn nx test token

To run the UI automation tests with a mocked API, run:

yarn nx run token-e2e:e2e

See also