diff options
Diffstat (limited to 'packages/website/README.md')
| -rw-r--r-- | packages/website/README.md | 69 |
1 files changed, 0 insertions, 69 deletions
diff --git a/packages/website/README.md b/packages/website/README.md deleted file mode 100644 index 432b7c335..000000000 --- a/packages/website/README.md +++ /dev/null @@ -1,69 +0,0 @@ -## Website & 0x Portal DApp - -This repository contains our website and [0x Portal DApp][portal-url] (over-the-counter exchange), facilitating trustless over-the-counter trading of Ethereum-based tokens using 0x protocol. - -[website-url]: https://0x.org/ -[portal-url]: https://0x.org/portal - -## 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](../../CONTRIBUTING.md) before getting started. - -## Local Dev Setup - -Requires Node version 6.9.5 or higher - -Add the following to your `/etc/hosts` file: - -``` -127.0.0.1 0xproject.localhost -``` - -### Install dependencies: - -```bash -yarn install -``` - -### Initial setup - -To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: - -```bash -PKG=@0x/website yarn build -``` - -### Run dev server - -```bash -PKG=@0x/website yarn watch -``` - -Visit [0xproject.localhost:3572](http://0xproject.localhost:3572) in your browser. - -### Clean - -```bash -yarn clean -``` - -### Lint - -```bash -yarn lint -``` - -### Resources - -##### Toolkit - -- [Material Design Icon Font](http://zavoloklom.github.io/material-design-iconic-font/icons.html#directional) -- [BassCSS toolkit](http://basscss.com/) -- [Material-UI component library](http://www.material-ui.com/#/) - -##### Recommended Atom packages: - -- [atom-typescript](https://atom.io/packages/atom-typescript) -- [linter-tslint](https://atom.io/packages/linter-tslint) |