9006acb4c5
* Create the wallet store * Get the updater completed * Code complete * Fix token balance bug * Fix another bug in the hooks * Final bug fix, blockNumber can be undefined * Formalize the fact that block number can be undefined * Woops add package * Add more info to errors * Replace balances in the v1 methods with the new ones * Only return a balance value if it's present * Address comments * Trigger updateVersion before anything else
64 lines
2.7 KiB
Markdown
64 lines
2.7 KiB
Markdown
# Uniswap Frontend
|
|
|
|
[](https://app.netlify.com/sites/uniswap/deploys)
|
|
[](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)
|
|
|
|
## 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 (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
|
|
[eth-scan](https://github.com/MyCryptoHQ/eth-scan) are deployed.
|
|
The frontend is not expected to work with local testnets.
|
|
|
|
### Deployment
|
|
|
|
As a single page application, all routes that do not match an asset must be redirect to `/index.html`.
|
|
See [create-react-app documentation.](https://create-react-app.dev/docs/deployment#notes-on-client-side-routing).
|
|
|
|
## Contributions
|
|
|
|
**Please open all pull requests against the `v2` branch.**
|
|
CI checks will run against all PRs.
|