diff --git a/README.md b/README.md index 912d92826..e31e9f66e 100644 --- a/README.md +++ b/README.md @@ -1,90 +1,47 @@ -# NxMonorepo +# Vega front-end monorepo -This project was generated using [Nx](https://nx.dev). +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](https://nx.dev). -🔎 **Smart, Fast and Extensible Build System** +# 🔎 Applications in this repo -## Adding capabilities to your workspace +### [Block explorer](https://github.com/vegaprotocol/frontend-monorepo/tree/master/apps/explorer) -Nx supports many plugins which add capabilities for developing different types of applications and different tools. +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. -These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well. +### [Trading UI](https://github.com/vegaprotocol/frontend-monorepo/tree/master/apps/trading) -Below are our core plugins: +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. -- [React](https://reactjs.org) - - `npm install --save-dev @nrwl/react` -- Web (no framework frontends) - - `npm install --save-dev @nrwl/web` -- [Angular](https://angular.io) - - `npm install --save-dev @nrwl/angular` -- [Nest](https://nestjs.com) - - `npm install --save-dev @nrwl/nest` -- [Express](https://expressjs.com) - - `npm install --save-dev @nrwl/express` -- [Node](https://nodejs.org) - - `npm install --save-dev @nrwl/node` +# 🧱 Libraries in this repo -There are also many [community plugins](https://nx.dev/community) you could add. +### [UI toolkit](https://github.com/vegaprotocol/frontend-monorepo/tree/master/libs/ui-toolkit) -## Generate an application +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. -Run `nx g @nrwl/react:app my-app` to generate an application. +### [Tailwind CSS config](https://github.com/vegaprotocol/frontend-monorepo/tree/master/libs/tailwindcss-config) -> You can use any of the plugins above to generate applications as well. +The Tailwind CSS config contains theme that align default config with Vega design system. -When using Nx, you can create multiple applications and libraries in the same workspace. +# đŸ’ģ Develop -## Generate a library - -Run `nx g @nrwl/react:lib my-lib` to generate a library. - -> You can also use any of the plugins above to generate libraries as well. - -Libraries are shareable across libraries and applications. They can be imported from `@nx-monorepo/mylib`. - -## Development server - -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. - -## Code scaffolding - -Run `nx g @nrwl/react:component my-component --project=my-app` to generate a new component. - -## Build +### 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. -## Running unit tests +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. -Run `nx test my-app` to execute the unit tests via [Jest](https://jestjs.io). +### Running tests -Run `nx affected:test` to execute the unit tests affected by a change. +Run `nx test my-app` to execute the unit tests with [Jest](https://jestjs.io), or `nx affected:test` to execute just unit tests affected by a change. -## Running end-to-end tests +Similarly `nx e2e my-app` will execute the end-to-end tests with [Cypress](https://www.cypress.io)., and `nx affected:e2e` will execute just the end-to-end tests affected by a change. -Run `nx e2e my-app` to execute the end-to-end tests via [Cypress](https://www.cypress.io). +### Further help with Nx -Run `nx affected:e2e` to execute the end-to-end tests affected by a change. +Visit the [Nx Documentation](https://nx.dev/getting-started/intro) to learn more. -## Understand your workspace +# 📑 License -Run `nx graph` to see a diagram of the dependencies of your projects. - -## Further help - -Visit the [Nx Documentation](https://nx.dev) to learn more. - -## ☁ Nx Cloud - -### Distributed Computation Caching & Distributed Task Execution - -

- -Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly. - -Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers. - -Visit [Nx Cloud](https://nx.app/) to learn more. +[MIT](./LICENSE)