Update and improve website README
This commit is contained in:
parent
5d24022209
commit
dd39fadce7
@ -1,8 +1,5 @@
|
||||
<img src="https://github.com/0xProject/branding/blob/master/0x_Black_CMYK.png" width="200px" >
|
||||
|
||||
---
|
||||
|
||||
[0x][website-url] is an open protocol that facilitates trustless, low friction exchange of Ethereum-based assets. A full description of the protocol may be found in our [whitepaper][whitepaper-url].
|
||||
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.
|
||||
|
||||
@ -10,51 +7,58 @@ This repository contains our website and [0x Portal DApp][portal-url] (over-the-
|
||||
[whitepaper-url]: https://0xproject.com/pdfs/0x_white_paper.pdf
|
||||
[portal-url]: https://0xproject.com/portal
|
||||
|
||||
[](https://gitter.im/0xProject/contracts?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://opensource.org/licenses/Apache-2.0)
|
||||
|
||||
### Local Dev Setup
|
||||
## Local Dev Setup
|
||||
|
||||
Requires Node version 6.9.5 or higher.
|
||||
|
||||
Add the following to your `/etc/hosts` file:
|
||||
|
||||
```
|
||||
127.0.0.1 0xproject.dev
|
||||
127.0.0.1 0xproject.localhost
|
||||
```
|
||||
|
||||
Clone the [0x contracts repo](https://github.com/0xProject/contracts) into the same parent directory as this project.
|
||||
### Install dependencies:
|
||||
|
||||
Install [yarn](https://yarnpkg.com/lang/en/docs/install/) in order to install the project dependencies more deterministically.
|
||||
|
||||
Install dependencies:
|
||||
|
||||
```
|
||||
yarn
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
|
||||
Import smart contract artifacts from `contracts` repo:
|
||||
### Run dev server
|
||||
|
||||
```
|
||||
yarn run update_contracts
|
||||
```
|
||||
|
||||
Start dev server:
|
||||
|
||||
```
|
||||
```bash
|
||||
yarn run dev
|
||||
```
|
||||
|
||||
Visit [0xproject.dev:3572](http://0xproject.dev:3572) in your browser.
|
||||
Visit [0xproject.localhost:3572](http://0xproject.localhost:3572) in your browser.
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
yarn build
|
||||
```
|
||||
|
||||
### 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)
|
||||
|
||||
##### Resources
|
||||
|
||||
- [Material Design Icon Font](http://zavoloklom.github.io/material-design-iconic-font/icons.html#directional)
|
||||
- [BassCSS toolkit](http://basscss.com/)
|
||||
- [Material-UI](http://www.material-ui.com/#/)
|
||||
|
Loading…
x
Reference in New Issue
Block a user