uniswap-interface-uncensored/README.md

66 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2020-07-01 13:09:37 -04:00
# Uniswap Interface
2019-04-15 12:07:16 -04:00
[![Tests](https://github.com/Uniswap/uniswap-interface/workflows/Tests/badge.svg)](https://github.com/Uniswap/uniswap-interface/actions?query=workflow%3ATests)
2019-04-15 14:05:54 -04:00
[![Styled With Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)
2019-04-15 12:07:16 -04:00
2020-05-08 13:51:47 -04:00
An open source interface for Uniswap -- a protocol for decentralized exchange of Ethereum tokens.
2018-01-18 14:15:59 -05:00
- Website: [uniswap.org](https://uniswap.org/)
2020-06-30 14:13:27 -04:00
- Interface: [app.uniswap.org](https://app.uniswap.org)
- Docs: [uniswap.org/docs/](https://uniswap.org/docs/)
- Twitter: [@UniswapProtocol](https://twitter.com/UniswapProtocol)
- Reddit: [/r/Uniswap](https://www.reddit.com/r/Uniswap/)
- Email: [contact@uniswap.org](mailto:contact@uniswap.org)
- Discord: [Uniswap](https://discord.gg/Y7TF6QA)
2019-04-15 14:05:54 -04:00
- Whitepaper: [Link](https://hackmd.io/C-DvwDSfSxuh-Gd4WKE_ig)
2020-06-30 14:13:27 -04:00
## Accessing the Uniswap Interface
2020-06-30 14:13:27 -04:00
To access the Uniswap Interface, use an IPFS gateway link from the
2020-06-30 13:53:18 -04:00
[latest release](https://github.com/Uniswap/uniswap-interface/releases/latest),
or visit [app.uniswap.org](https://app.uniswap.org).
2020-05-21 15:54:28 -04:00
## Listing a token
Please see the
[@uniswap/default-token-list](https://github.com/uniswap/default-token-list)
repository.
2020-05-21 15:54:28 -04:00
## Development
### Install Dependencies
```bash
yarn
```
### Run
2019-04-15 14:05:54 -04:00
```bash
yarn start
```
2020-06-30 14:13:27 -04:00
### Configuring the environment (optional)
To have the interface default to a different network when a wallet is not connected:
1. Make a copy of `.env` named `.env.local`
2. Change `REACT_APP_NETWORK_ID` to `"{YOUR_NETWORK_ID}"`
3. Change `REACT_APP_NETWORK_URL` to e.g. `"https://{YOUR_NETWORK_ID}.infura.io/v3/{YOUR_INFURA_KEY}"`
2020-06-30 14:13:27 -04:00
Note that the interface only works on testnets where both
[Uniswap V2](https://uniswap.org/docs/v2/smart-contracts/factory/) and
[multicall](https://github.com/makerdao/multicall) are deployed.
2020-06-30 14:13:27 -04:00
The interface will not work on other networks.
2019-04-15 14:05:54 -04:00
## Contributions
**Please open all pull requests against the `master` branch.**
2020-06-30 14:13:27 -04:00
CI checks will run against all PRs.
2020-06-30 14:13:27 -04:00
## Accessing Uniswap Interface V1
The Uniswap Interface supports swapping against, and migrating or removing liquidity from Uniswap V1. However,
if you would like to use Uniswap V1, the Uniswap V1 interface for mainnet and testnets is accessible via IPFS gateways
2020-07-01 13:09:37 -04:00
linked from the [v1.0.0 release](https://github.com/Uniswap/uniswap-interface/releases/tag/v1.0.0).