57 lines
2.0 KiB
Markdown
57 lines
2.0 KiB
Markdown
# Uniswap Frontend
|
|
|
|
[](https://github.com/Uniswap/uniswap-frontend/actions?query=workflow%3ATests)
|
|
[](https://prettier.io/)
|
|
|
|
An open source interface for Uniswap -- a protocol for decentralized exchange of Ethereum tokens.
|
|
|
|
- Website: [uniswap.org](https://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)
|
|
- Whitepaper: [Link](https://hackmd.io/C-DvwDSfSxuh-Gd4WKE_ig)
|
|
|
|
## Accessing the frontend
|
|
|
|
To access the front end, use an IPFS gateway link from the
|
|
[latest release](https://github.com/Uniswap/uniswap-frontend/releases/latest)
|
|
or visit [uniswap.exchange](https://uniswap.exchange).
|
|
|
|
## Development
|
|
|
|
### Install Dependencies
|
|
|
|
```bash
|
|
yarn
|
|
```
|
|
|
|
### Configure Environment (optional)
|
|
|
|
Copy `.env` to `.env.local` and change the appropriate variables.
|
|
|
|
### Run
|
|
|
|
```bash
|
|
yarn start
|
|
```
|
|
|
|
To have the frontend default to a different network, make a copy of `.env` named `.env.local`,
|
|
change `REACT_APP_NETWORK_ID` to `"{yourNetworkId}"`, and change `REACT_APP_NETWORK_URL` to e.g.
|
|
`"https://{yourNetwork}.infura.io/v3/{yourKey}"`.
|
|
|
|
Note that the front end only works properly on testnets where both
|
|
[Uniswap V2](https://uniswap.org/docs/v2/smart-contracts/factory/) and
|
|
[multicall](https://github.com/makerdao/multicall) are deployed.
|
|
The frontend will not work on other networks.
|
|
|
|
## Contributions
|
|
|
|
**Please open all pull requests against the `v2` branch.**
|
|
CI checks will run against all PRs.
|
|
|
|
## Accessing Uniswap V1 interface
|
|
|
|
The Uniswap V1 interface for mainnet and testnets is accessible via IPFS gateways linked
|
|
from the [v1.0.0 release](https://github.com/Uniswap/uniswap-frontend/releases/tag/v1.0.0). |