|
1 | | -# Fork Uniswap Interface v3 |
| 1 | +# Front end for Uniswap v3.3.6 |
2 | 2 |
|
3 | | -The current branch is a fork of the v3.3.6 tag. |
| 3 | +## Prerequisites |
4 | 4 |
|
5 | | -## Development |
| 5 | +1. [Git](https://git-scm.com) |
| 6 | +2. [Node.js](https://nodejs.org/en) v16.20.2 |
| 7 | +3. [Yarn](https://classic.yarnpkg.com/lang/en) v1.22.22 |
6 | 8 |
|
7 | | -Node.js v16 required (Checked on v16.20.2). |
| 9 | +## Setting Up |
8 | 10 |
|
9 | | -### Install Dependencies |
| 11 | +1. Clone the repository |
10 | 12 |
|
11 | 13 | ```bash |
12 | | -yarn install |
| 14 | +git clone https://github.com/fullstack-development/uniswap-v3-interface.git |
13 | 15 | ``` |
14 | 16 |
|
15 | | -### Run |
| 17 | +2. Install dependencies |
16 | 18 |
|
17 | 19 | ```bash |
18 | | -yarn start |
19 | | -``` |
20 | | - |
21 | | -After generating types go to `src/types/v3/index.ts` and add two lines: |
22 | | - |
23 | | -```ts |
24 | | -export type { UniswapV3Factory } from './UniswapV3Factory' |
25 | | -export type { UniswapV3Pool } from './UniswapV3Pool' |
| 20 | +yarn |
26 | 21 | ``` |
27 | 22 |
|
28 | | -## Uniswap Interface |
29 | | - |
30 | | -[](https://github.com/Uniswap/uniswap-interface/actions/workflows/unit-tests.yaml) |
31 | | -[](https://github.com/Uniswap/uniswap-interface/actions/workflows/integration-tests.yaml) |
32 | | -[](https://github.com/Uniswap/uniswap-interface/actions/workflows/lint.yml) |
33 | | -[](https://github.com/Uniswap/uniswap-interface/actions/workflows/release.yaml) |
34 | | - |
35 | | -An open source interface for Uniswap -- a protocol for decentralized exchange of Ethereum tokens. |
36 | | - |
37 | | -- Website: [uniswap.org](https://uniswap.org/) |
38 | | -- Interface: [app.uniswap.org](https://app.uniswap.org) |
39 | | -- Docs: [uniswap.org/docs/](https://uniswap.org/docs/) |
40 | | -- Twitter: [@UniswapProtocol](https://twitter.com/UniswapProtocol) |
41 | | -- Reddit: [/r/Uniswap](https://www.reddit.com/r/Uniswap/) |
42 | | - |
43 | | -- Discord: [Uniswap](https://discord.gg/FCfyBSbCU5) |
44 | | -- Whitepaper: [Link](https://hackmd.io/C-DvwDSfSxuh-Gd4WKE_ig) |
45 | | - |
46 | | -## Accessing the Uniswap Interface |
47 | | - |
48 | | -To access the Uniswap Interface, use an IPFS gateway link from the |
49 | | -[latest release](https://github.com/Uniswap/uniswap-interface/releases/latest), |
50 | | -or visit [app.uniswap.org](https://app.uniswap.org). |
51 | | - |
52 | | -## Contributions |
| 23 | +## Development |
53 | 24 |
|
54 | | -**Please open all pull requests against the `main` branch.** |
55 | | -CI checks will run against all PRs. |
| 25 | +1. Start the server |
56 | 26 |
|
57 | | -## Accessing Uniswap V2 |
| 27 | +```bash |
| 28 | +yarn start |
| 29 | +``` |
58 | 30 |
|
59 | | -The Uniswap Interface supports swapping, adding liquidity, removing liquidity and migrating liquidity for |
60 | | -Uniswap protocol V2. |
| 31 | +## Production |
61 | 32 |
|
62 | | -- Swap on Uniswap V2: https://app.uniswap.org/#/swap?use=v2 |
63 | | -- View V2 liquidity: https://app.uniswap.org/#/pool/v2 |
64 | | -- Add V2 liquidity: https://app.uniswap.org/#/add/v2 |
65 | | -- Migrate V2 liquidity to V3: https://app.uniswap.org/#/migrate/v2 |
| 33 | +1. Build the app |
66 | 34 |
|
67 | | -## Accessing Uniswap V1 |
68 | | - |
69 | | -The Uniswap V1 interface for mainnet and testnets is accessible via IPFS gateways |
70 | | -linked from the [v1.0.0 release](https://github.com/Uniswap/uniswap-interface/releases/tag/v1.0.0). |
| 35 | +```bash |
| 36 | +yarn build |
| 37 | +``` |
0 commit comments