50 lines
2.5 KiB
Markdown
50 lines
2.5 KiB
Markdown
# Uniswap Frontend
|
|
|
|
[](https://app.netlify.com/sites/uniswap/deploys)
|
|
[](https://travis-ci.org/Uniswap/uniswap-frontend)
|
|
[](https://prettier.io/)
|
|
|
|
This an an open source interface for Uniswap - a protocol for decentralized exchange of Ethereum tokens.
|
|
|
|
- Website: [uniswap.io](https://uniswap.io/)
|
|
- Docs: [docs.uniswap.io](https://docs.uniswap.io/)
|
|
- Twitter: [@UniswapExchange](https://twitter.com/UniswapExchange)
|
|
- Reddit: [/r/Uniswap](https://www.reddit.com/r/UniSwap/)
|
|
- Email: [contact@uniswap.io](mailto:contact@uniswap.io)
|
|
- Discord: [Uniswap](https://discord.gg/Y7TF6QA)
|
|
- Whitepaper: [Link](https://hackmd.io/C-DvwDSfSxuh-Gd4WKE_ig)
|
|
|
|
## Run Uniswap Locally
|
|
|
|
1. Download and unzip the `build.zip` file from the latest release in the [Releases tab](https://github.com/Uniswap/uniswap-frontend/releases/latest).
|
|
|
|
2. Serve the `build/` folder locally, and access the application via a browser.
|
|
|
|
For more information on running a local server see [https://developer.mozilla.org/en-US/docs/Learn/Common_questions/set_up_a_local_testing_server](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/set_up_a_local_testing_server). This simple approach has one downside: refreshing the page will give a `404` because of how React handles client-side routing. To fix this issue, consider running `serve -s` courtesy of the [serve](https://github.com/zeit/serve) package.
|
|
|
|
## Develop Uniswap Locally
|
|
|
|
### Install Dependencies
|
|
|
|
```bash
|
|
yarn
|
|
```
|
|
|
|
### Configure Environment
|
|
|
|
Rename `.env.local.example` to `.env.local` and fill in the appropriate variables.
|
|
|
|
### Run
|
|
|
|
```bash
|
|
yarn start
|
|
```
|
|
|
|
To run on a testnet, make a copy of `.env.local.example` 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}"`.
|
|
|
|
If deploying with Github Pages, be aware that there's some [tricky client-side routing behavior with `create-react-app`](https://create-react-app.dev/docs/deployment#notes-on-client-side-routing).
|
|
|
|
## Contributions
|
|
|
|
**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.
|