Website & 0x Portal DApp
This repository contains our website and 0x Portal DApp (over-the-counter exchange), facilitating trustless over-the-counter trading of Ethereum-based tokens using 0x protocol.
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.
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:
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:
PKG=@0x/website yarn build
Run dev server
PKG=@0x/website yarn watch
Visit 0xproject.localhost:3572 in your browser.
Clean
yarn clean
Lint
yarn lint
Indexing docs
yarn index_docs
The above script will index all the docs found in the /mdx folder on Algolia. It's possible to pass in arguments that match the directory names to index only those document types, i.e. yarn index_docs tools core-concepts will index tools and core concepts.
Running the script updates some of the meta information about the files (relative paths to files and versions of the doc). For other types of information (i.e. title, subtitle, tags...) you will have to update it yourself.