History

Dexter Edwards 9e82935658 Chore/more docs (#331 ) * chore renable prettier md files * remove duplicated information, add instructions on running formatting * add more docs for other apps a libraries * correct numbering * Missing applications * correction for serving * more docs		2022-05-03 16:32:31 +01:00
..
src	Use types from web3-react library	2022-05-02 13:16:57 -04:00
.babelrc	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
.browserslistrc	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
.env	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
.env.devent	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
.env.mainnet	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
.env.stagnet1	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
.env.stagnet2	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
.env.testnet	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
.eslintrc.json	Fixes for workflows (#291 )	2022-04-22 17:51:18 -07:00
jest.config.js	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
netlify.toml	add build netlify command and netlify.toml for token dapp (#302 )	2022-04-26 07:32:23 -07:00
postcss.config.js	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
project.json	add build netlify command and netlify.toml for token dapp (#302 )	2022-04-26 07:32:23 -07:00
README.md	Chore/more docs (#331 )	2022-05-03 16:32:31 +01:00
tailwind.config.js	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
tsconfig.app.json	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
tsconfig.json	run nx format (#295 )	2022-04-25 15:03:58 +01:00
tsconfig.spec.json	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00
webpack.config.js	Feat/224 move token app into monorepo (#229 )	2022-04-20 12:37:44 -07:00

README.md

The Vega token website

Control panel for your VEGA tokens

Features

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

Development

Starting the app:

yarn nx serve token

Configuration

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