Merge branch 'master' of github.com:davidcoderistov/monoswap

Author: davidcoderistov

README.md

@@ -1,46 +1,49 @@
-# Getting Started with Create React App
+![monoswap](https://user-images.githubusercontent.com/85624034/196651582-261492cd-c17b-4a03-84e6-d54f5c6ca943.png)
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+Monoswap is a decentralized exchange (DEX) multi-chain dApp that facilitates trading of ERC20 tokens. It uses Uniswap [Token Lists](https://tokenlists.org/), a new community-led standard for creating lists of ERC20 tokens to improve discoverability and trust in ERC20 token lists in a manner that is inclusive, transparent, and decentralized. Swapping is powered by the [0x Protocol](https://www.0x.org/), an open protocol that enables the decentralized exchange of tokens on the Ethereum blockchain.
 
-## Available Scripts
+### Core features
+- Connecting to [Metamask](https://metamask.io/)
+- Multi-chain support: Ethereum, Polygon, Optimism, Arbitrum and Goerli
+- Standardized set of ERC20 tokens using Uniswap [Token Lists](https://tokenlists.org/)
+- Swapping ERC20 tokens using the [0x Protocol](https://www.0x.org/)
+- View token balance
+- View transactions history and transaction status
 
-In the project directory, you can run:
+### API endpoints
+- [tokens.uniswap.org/](https://tokens.uniswap.org/) for getting the token lists
+- [alchemy_getTokenBalances](https://docs.alchemy.com/reference/alchemy-gettokenbalances) for getting the token balances
+- [/swap/v1/quote](https://docs.0x.org/0x-api-swap/api-references/get-swap-v1-quote) for getting the quote for buying or selling any ERC20 token
+- [/swap/v1/price](https://docs.0x.org/0x-api-swap/api-references/get-swap-v1-price) for getting the best price for buying or selling any ERC20 token
 
-### `npm start`
+### Using Monoswap
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
-
-### `npm test`
+#### `REACT_APP_ALCHEMY_API_KEY`
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+Set up local environment variable by creating a .env.development.local file in the root of your project and add your [Alchemy](https://www.alchemy.com/) API key.
 
-### `npm run build`
+#### `npm install`
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+Installs all packages.
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+#### `npm start`
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+Runs the app in the development mode.
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+The page will reload if you make edits.
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+### Contributing to Monoswap
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+To contribute to Monoswap, follow these steps:
+1. Fork this repository
+2. Create a branch: `git checkout -b <branch_name>`
+3. Make your changes and commit them: `git commit -m '<commit_message>'`
+4. Push to the original branch: `git push origin Monoswap/<location>`
+5. Create the pull request
 
-## Learn More
+Alternatively see the GitHub documentation on [creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+### Contact
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+If you want to contact me you can reach me at [[email protected]](mailto:[email protected]).