Oasis - Decentralized Token Market
Clone or download

README.md

Oasis Header

Stories in Ready Build Status

This is a simple on-chain OTC market for ERC20 Standard Tokens on the Ethereum Blockchain. You can either pick an order from the order book (in which case delivery will happen instantly), or submit a new order yourself.

Oasis is undergoing alpha testing: Proceed at your own risk, and use only small amounts of ETH and MKR.

Overview

This dapp uses Meteor as frontend; the contract side can be tested and deployed using dapple.

Usage (for Users)

Ensure you have a locally running ethereum node.

Installation (for Developers)

Requirements:

Clone and install:

git clone https://github.com/OasisDEX/oasis.git
cd oasis
npm install

Usage (for Developers)

To run the frontend, start meteor:

cd frontend 
npm install
meteor

You can access the user interface on http://localhost:3000/

To deploy the frontend to Github Pages:

gulp deploy

Development

This project uses the AirBnB style guide for coding standard guidelines. We use ESLint to automatically check for common code problems or style errors. There's an eslintConfig section in frontend/package.json for the configuration of ESLint. You can run the linter with:

cd frontend
meteor npm run lint

License

This project is licensed under the terms of the Apache License 2.0.

TODOs

See https://waffle.io/MakerDAO/maker-market

Acknowledgements