Files
protocol/packages/dev-tools-pages/README.md
Fabio Berger 19a657c38b Improve README
2018-10-10 22:40:14 +02:00

1.6 KiB

Dev tools pages

This repository contains our dev tools pages.

Local Dev Setup

Requires Node version 6.9.5 or higher & yarn v1.9.4

1. Install dependencies for monorepo:

Make sure you install Yarn v1.9.4 (npm won't work!). We rely on our yarn.lock file and on Yarn's support for workspaces in our monorepo setup.

yarn install

2. Initial setup

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

PKG=@0xproject/dev-tools-pages yarn build

Note: Ignore the WARNING in asset size limit and WARNING in entrypoint size limit warnings.

3. Run dev server

cd packages/dev-tools-pages
yarn dev

Visit http://localhost:3572/ in your browser.

The webpage will refresh when source code is changed.

Clean

yarn clean

Lint

yarn lint

Prettier

Run from the monorepo root directory:

yarn prettier

Resources

Toolkit

Contributing

We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.

Please read our contribution guidelines before getting started.