vega-frontend-monorepo/README.md
candida-d 1010db6ce4
Task/73 Update readme
* Write readme

* Mention Tailwind CSS config lib in readme

Co-authored-by: Bartłomiej Głownia <bglownia@gmail.com>
2022-03-14 08:21:26 -07:00

2.1 KiB

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.

🧱 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.

Tailwind CSS config

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

💻 Develop

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 http://localhost:4200/. The app will automatically reload if you change any of the source files.

Running tests

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.

Similarly nx e2e my-app will execute the end-to-end tests with Cypress., and nx affected:e2e will execute just the end-to-end tests affected by a change.

Further help with Nx

Visit the Nx Documentation to learn more.

📑 License

MIT