2018-10-30 07:18:03 +03:00
# Uniswap Frontend
2019-04-15 19:07:16 +03:00
[![Netlify Status ](https://api.netlify.com/api/v1/badges/fa110555-b3c7-4eeb-b840-88a835009c62/deploy-status )](https://app.netlify.com/sites/uniswap/deploys)
2019-04-16 00:46:48 +03:00
[![Build Status ](https://travis-ci.org/Uniswap/uniswap-frontend.svg )](https://travis-ci.org/Uniswap/uniswap-frontend)
2019-04-15 21:05:54 +03:00
[![Styled With Prettier ](https://img.shields.io/badge/code_style-prettier-ff69b4.svg )](https://prettier.io/)
2019-04-15 19:07:16 +03:00
2018-11-21 01:03:05 +03:00
This an an open source interface for Uniswap - a protocol for decentralized exchange of Ethereum tokens.
2018-01-18 22:15:59 +03:00
2019-04-16 00:46:48 +03:00
- Website: [uniswap.io ](https://uniswap.io/ )
- Docs: [docs.uniswap.io ](https://docs.uniswap.io/ )
2019-04-15 21:05:54 +03:00
- Twitter: [@UniswapExchange ](https://twitter.com/UniswapExchange )
2019-04-16 00:46:48 +03:00
- Reddit: [/r/Uniswap ](https://www.reddit.com/r/UniSwap/ )
2019-04-15 21:05:54 +03:00
- Email: [contact@uniswap.io ](mailto:contact@uniswap.io )
- Slack: [uni-swap.slack.com/ ](https://join.slack.com/t/uni-swap/shared_invite/enQtNDYwMjg1ODc5ODA4LWEyYmU0OGU1ZGQ3NjE4YzhmNzcxMDAyM2ExNzNkZjZjZjcxYTkwNzU0MGE3M2JkNzMxOTA2MzE2ZWM0YWQwNjU )
- Whitepaper: [Link ](https://hackmd.io/C-DvwDSfSxuh-Gd4WKE_ig )
2018-11-02 11:30:09 +03:00
2019-04-15 21:05:54 +03:00
## To Start Development
2018-11-02 11:30:09 +03:00
2019-04-25 19:12:47 +03:00
### Install Dependencies
2018-11-02 11:30:09 +03:00
```bash
yarn
```
2019-04-25 19:12:47 +03:00
### Configure Environment
2019-04-15 21:05:54 +03:00
2019-05-30 23:42:25 +03:00
Rename `.env.local.example` to `.env.local` and fill in the appropriate variables.
2018-11-02 11:30:09 +03:00
2019-04-25 19:12:47 +03:00
### Run
2019-04-15 21:05:54 +03:00
2018-11-02 11:30:09 +03:00
```bash
2019-04-25 19:12:47 +03:00
yarn start
2018-11-02 11:30:09 +03:00
```
2019-05-30 23:42:25 +03:00
To run on a testnet, simply update the `.env.local` file appropriately.
2019-04-25 19:12:47 +03:00
2019-04-15 21:05:54 +03:00
## Contributions
2019-04-16 03:06:39 +03:00
**Please open all pull requests against the `beta` branch.** CI checks will run against all PRs. To ensure that your changes will pass, run `yarn check:all` before pushing. If this command fails, you can try to automatically fix problems with `yarn fix:all` , or do it manually.