yashsinha2512 / website Goto Github PK

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.

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

Please read our contribution guidelines before getting started.

Requires Node version 6.9.5 or higher

Add the following to your /etc/hosts file:

127.0.0.1 0xproject.localhost

You will also need to have the aws CLI installed locally and your credentials set up correctly.

yarn install

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

yarn build

yarn dev

Visit 0xproject.localhost:3572 in your browser.

yarn clean

yarn lint

Before you can index the docs on Algolia, you need to set the admin API key environment variable:

# 0x Website frontend
export ALGOLIA_ADMIN_API_KEY={YOUR_ADMIN_API_KEY}

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 --indexes 'tools,core-concepts' --environment development will index tools and core concepts for development.

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.

• Material Design Icon Font
• BassCSS toolkit
• Material-UI component library

• atom-typescript
• linter-tslint