Toolkit for building apps that interact with Vega
Go to file
Sam Keen 6eb52c9a65
Feat/304 token scss to tailwind - part 1 (#327)
* Converted app.scss

* Made a start converting styles.scss

* commenting out unused colours - test for now

* restoring font-family

* Added correct text colour and height to top level elements

* Eth connect button styling

* Truncated wallet key on staking screen (had been causing overflow)

* Tranches Scss to tailwind

* Withdraw form Scss to tailwind

* Part way done with staking Scss to tailwind

* Removed redundant containerClass prop from epoch-countdown

* Cleanup of colors part 1

* Ran prettier

* Changes from the MR - removed epoch-countdown styles (apart from blueprint, which has moved to styles.scss)

* Changes from mr - removed extra button size classes (to be replaced with a prop later)

* Changes from mr - allow Tailwind's default list styles. Added role="list" for accessibility

* Border-box applied via wildcard again

* MR tweaks

* Removing the eslint warning for using role="list" on unstyled lists

* Correctly naming the jsx-ally plugin in the eslintrc file so that rules were correctly applied

* Removed redundant 'list-none' classes as Tailwind applies this by default for lists
2022-05-09 00:53:02 +01:00
.github/workflows run nx format (#295) 2022-04-25 15:03:58 +01:00
.husky rrun nx commands through yarn 2022-03-02 12:21:58 +00:00
.storybook Add storybook/addon-a11y 2022-03-07 13:57:06 -08:00
.vscode Feat/300 network parameters table (#333) 2022-05-04 18:15:54 +03:00
apps Feat/304 token scss to tailwind - part 1 (#327) 2022-05-09 00:53:02 +01:00
libs Feat/300 network parameters table (#333) 2022-05-04 18:15:54 +03:00
tools Fix IPFS change detection 2022-04-13 09:35:09 +00:00
.editorconfig Normalize line endings (#207) 2022-04-06 11:59:51 +01:00
.eslintrc.json Feat/304 token scss to tailwind - part 1 (#327) 2022-05-09 00:53:02 +01:00
.gitattributes Normalize line endings (#207) 2022-04-06 11:59:51 +01:00
.gitignore #29 Add market-list-table 2022-03-18 13:13:14 +01:00
.nvmrc Add .nvmrc and engine, set node version to 16.14.0 2022-02-17 13:43:41 +01:00
.prettierignore Chore/more docs (#331) 2022-05-03 16:32:31 +01:00
.prettierrc Create a Mono-repo for DeFiUI + ui toolkit using nx 2022-02-11 15:02:11 +01:00
.sentryclirc Chore/sentry (#163) 2022-03-29 18:29:29 +01:00
babel.config.json Create a Mono-repo for DeFiUI + ui toolkit using nx 2022-02-11 15:02:11 +01:00
CODEOWNERS add code owners 2022-02-23 08:53:57 +00:00
jest.config.js Create a Mono-repo for DeFiUI + ui toolkit using nx 2022-02-11 15:02:11 +01:00
jest.preset.js Create a Mono-repo for DeFiUI + ui toolkit using nx 2022-02-11 15:02:11 +01:00
LICENSE Create a Mono-repo for DeFiUI + ui toolkit using nx 2022-02-11 15:02:11 +01:00
migrations.json Fixes for workflows (#291) 2022-04-22 17:51:18 -07:00
netlify.toml Remove custom ignore (#221) 2022-04-07 12:24:04 +01:00
nx.json [#168] Add static app to host AlphaLyrae font 2022-03-31 09:11:29 +02:00
package.json Ci/fix trading netlify build (#383) 2022-05-06 12:54:17 +01:00
README.md Chore/more docs (#331) 2022-05-03 16:32:31 +01:00
tsconfig.base.json Feat/104 withdraws (#263) 2022-04-26 19:51:39 -07:00
workspace.json Feat/104 withdraws (#263) 2022-04-26 19:51:39 -07:00
yarn.lock Ci/fix trading netlify build (#383) 2022-05-06 12:54:17 +01:00

Vega front-end monorepo

The front-end monorepo provides a toolkit for building apps that interact with Vega, as well as the apps themselves.

This repository is managed using Nx.

🔎 Applications in this repo

Block explorer

The Vega block explorer provides an interface that allows users to search for and see transactions, blocks, parties, assets, markets and more on the Vega chain.

Trading UI

The trading interface built based on a component toolkit. It will provide a way for participants to interact with markets and provide resources for others to build additional open-source user interfaces.

Token

The utlity dApp for interacting with the Vega token and using its' utility. This includes; delegation, nomination, governance and redemption of tokens.

Explorer

The block explorer for the Vega network, showing details of raw chain states and the state of markets on the Vega network.

Stats

An application for the status of the Vega network. Showing block height and other network activity.

Static

Hosting for static content being shared across apps, for example fonts.

🧱 Libraries in this repo

UI toolkit

The UI toolkit contains a set of components used to build interfaces that can interact with the Vega protocol, and follow the design style of the project. It contains a storybook that can be served with yarn nx run ui-toolkit:storybook.

Tailwind CSS config

The Tailwind CSS config contains theme that align default config with Vega design system.

Cypress

For shared Cypress logic, commands and steps.

Web3

A ulitity library for connecting to the Ethereum network and interacting with Vega Web3 contracts.

React Helpers

Generic react helpers that can be used across multilpe applications, along with other utilties.

💻 Develop

Set up

Check you have the correct version of Node. You can install NVM to switch between node versions. Then NVM install. Before you build you will need to yarn install in the root directory. The repository includes a number of template .env files for different networks. Copy from these to the .env file before serve to launch app with different network. You can serve any application with yarn nx run <name-of-app>:serve.

Build

Run nx build my-app to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Run nx serve my-app for a dev server. Navigate to the port specified in app/<project-name>/project.json. The app will automatically reload if you change any of the source files.

Running tests

Run yarn nx run <my-app>-e2e:e2e to execute the e2e tests with cypress, or nx affected:e2e will execute just the end-to-end tests affected by a change. You can use the --watch flag to open the cypress tests UI in watch mode, see cypress executor for all CLI flags.

Run nx test my-app to execute the unit tests with Jest, or nx affected:test to execute just unit tests affected by a change. You can also use --watch with these test to run jest in watch mode, see Jest executor for all CLI flags.

Formatting

In CI linting, formatting and also run. These checks can be seen in the CI workflow file.

  • To fix linting errors locally run yarn nx lint --fix
  • To fix formatting errors local run yarn nx format
  • For either command you may use --all to run across the entire repository

Further help with Nx

Visit the Nx Documentation to learn more.

Vegacapsule

Explorer

Follow the following steps to start using a local network with the Vega Explorer:

  1. Prepare vegacapsule. Follow the Vegacapsule instructions
  2. Build the explorer frontend application
  3. Start the explorer frontend application with the .env.vegacapsule env file
  4. Go to http://localhost:3000 in your browser

If you simply want to run Explorer locally, without using a local network:

cd apps/explorer && cp .env.testnet .env.local
yarn nx run explorer:serve

📑 License

MIT