Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Utkarshbhimte committed Jun 1, 2024
1 parent b5f148f commit 796a963
Showing 1 changed file with 41 additions and 36 deletions.
77 changes: 41 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,56 @@
# Uniswap Labs Interface
# ProxySwap Frontend

[![Unit Tests](https://github.com/Uniswap/interface/actions/workflows/unit-tests.yaml/badge.svg)](https://github.com/Uniswap/interface/actions/workflows/unit-tests.yaml)
[![Integration Tests](https://github.com/Uniswap/interface/actions/workflows/integration-tests.yaml/badge.svg)](https://github.com/Uniswap/interface/actions/workflows/integration-tests.yaml)
[![Lint](https://github.com/Uniswap/interface/actions/workflows/lint.yml/badge.svg)](https://github.com/Uniswap/interface/actions/workflows/lint.yml)
[![Release](https://github.com/Uniswap/interface/actions/workflows/release.yaml/badge.svg)](https://github.com/Uniswap/interface/actions/workflows/release.yaml)
[![Crowdin](https://badges.crowdin.net/uniswap-interface/localized.svg)](https://crowdin.com/project/uniswap-interface)
Welcome to the frontend repository for ProxySwap, a Uniswap V3 fork designed to operate on the DegenChain L3 blockchain. This repository contains the user interface and client-side components of ProxySwap.

An open source interface for Uniswap -- a protocol for decentralized exchange of Ethereum tokens.
## Features

- Website: [uniswap.org](https://uniswap.org/)
- Interface: [app.uniswap.org](https://app.uniswap.org)
- Docs: [uniswap.org/docs/](https://docs.uniswap.org/)
- Twitter: [@Uniswap](https://twitter.com/Uniswap)
- Reddit: [/r/Uniswap](https://www.reddit.com/r/Uniswap/)
- Email: [[email protected]](mailto:[email protected])
- Discord: [Uniswap](https://discord.gg/FCfyBSbCU5)
- Whitepapers:
- [V1](https://hackmd.io/C-DvwDSfSxuh-Gd4WKE_ig)
- [V2](https://uniswap.org/whitepaper.pdf)
- [V3](https://uniswap.org/whitepaper-v3.pdf)
- Token Swapping: Users can easily swap between various tokens supported by the DegenChain L3 blockchain.
- Liquidity Provision: Liquidity providers can contribute to liquidity pools and earn rewards.
- Intuitive User Interface: The frontend offers a user-friendly and intuitive interface for a smooth trading experience.
- DegenChain L3 Integration: ProxySwap is fully integrated with the DegenChain L3 blockchain, ensuring fast and cost-effective transactions.

## Accessing the Uniswap Interface
## Getting Started

To access the Uniswap Interface, use an IPFS gateway link from the
[latest release](https://github.com/Uniswap/uniswap-interface/releases/latest),
or visit [app.uniswap.org](https://app.uniswap.org).
To run the ProxySwap frontend locally, follow these steps:

## Unsupported tokens
1. Clone this repository:
```
git clone https://github.com/makerdock/proxyswap.git
```

Check out `useUnsupportedTokenList()` in [src/state/lists/hooks.ts](./src/state/lists/hooks.ts) for blocking tokens in your instance of the interface.
2. Navigate to the project directory:
```
cd proxyswap
```

You can block an entire list of tokens by passing in a tokenlist like [here](./src/constants/lists.ts) or you can block specific tokens by adding them to [unsupported.tokenlist.json](./src/constants/tokenLists/unsupported.tokenlist.json).
3. Install the dependencies:
```
npm install
```

## Contributions
4. Start the development server:
```
npm start
```

For steps on local deployment, development, and code contribution, please see [CONTRIBUTING](./CONTRIBUTING.md).
6. Open your browser and visit `http://localhost:3000` to access the ProxySwap frontend.

## Accessing Uniswap V2
## Contributing

The Uniswap Interface supports swapping, adding liquidity, removing liquidity and migrating liquidity for Uniswap protocol V2.
We welcome contributions from the community to enhance ProxySwap. To contribute, please follow these steps:

- Swap on Uniswap V2: https://app.uniswap.org/#/swap?use=v2
- View V2 liquidity: https://app.uniswap.org/#/pool/v2
- Add V2 liquidity: https://app.uniswap.org/#/add/v2
- Migrate V2 liquidity to V3: https://app.uniswap.org/#/migrate/v2
1. Fork this repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive commit messages.
4. Push your changes to your forked repository.
5. Submit a pull request to the main repository.

## Accessing Uniswap V1
Please ensure that your code adheres to the project's coding standards and includes appropriate tests.

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-interface/releases/tag/v1.0.0).
## Contact

If you have any questions, suggestions, or feedback, please feel free to reach out to us:

- Farcaster: [/proxyswap](https://warpcast.com/~/channel/proxyswap)

We appreciate your interest in ProxySwap and look forward to building a thriving DEX ecosystem on the DegenChain L3 blockchain together!

0 comments on commit 796a963

Please sign in to comment.