Merge pull request #17 from liftlearning/improve-readme

Improve readme

README.md

@@ -1,12 +1,19 @@
-# P2Pix-Front-End
+<p align="center">
+  <img src="./src/assets/colored_logo.svg" alt="Logo P2Pix" width="40%"/>
+</p>
+<br />
 
-This template should help get you started developing with Vue 3 in Vite.
+This application aims to create a democratic and secure solution for the purchase and sale of ERC20 tokens, through the PIX, integrating the functionalities of smart contracts (smart contracts) of the blockchain with a receipt by digital signature. Allowing the integration of national financial system transactions to public blockchains, dispensing with custody through intermediaries.
 
+# Table of Contents
+* [Recommended IDE Setup](#recommended-ide-setup)
+* [Dependencies](#dependencies)
+* [Build Setup](#build-setup)
 ## Recommended IDE Setup
 
 [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
 
-## Type Support for `.vue` Imports in TS
+### Type Support for `.vue` Imports in TS
 
 TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
 
@@ -17,41 +24,51 @@ If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has a
     2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
 2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
 
-## Customize configuration
+### Customize configuration
 
 See [Vite Configuration Reference](https://vitejs.dev/config/).
 
-## Project Setup (with yarn)
 
+## Dependencies
+
+### Smart Contract
+It is necessary to be running the smart contract locally to have access to all the functionalities of the application. The smart contract repository and instructions on how to run it can be found at [https://github.com/doiim/p2pix-smart-contracts](https://github.com/doiim/p2pix-smart-contracts)
+
+### API
+For full operation of the application, it is necessary to correctly configure the variable that points to the api in the .env file, in the repository there is an .env.example file, just rename it to just .env and modify the variable `VITE_API_URL`. The api can be run locally see [https://github.com/liftlearning/Pix-Explorer-Back-End](https://github.com/liftlearning/Pix-Explorer-Back-End), or it can be pointed to just her staging address: [https://p2pix-block-explorer-api-staging.vercel.app/](https://p2pix-block-explorer-api-staging.vercel.app/)
+
+## Build Setup
+
+The application can be tested by its trial version [https://p2pix-staging.vercel.app/](https://p2pix-staging.vercel.app/), the only requirement is to be running the smart contract of local way. To run the application locally, there are two different ways:
+
+### Run with yarn
 ```sh
-yarn
-```
+# Clone the repo
+git clone https://github.com/liftlearning/P2Pix-Front-End
+cd P2Pix-Front-End
 
-### Compile and Hot-Reload for Development
+# Install dependencies with yarn
+yarn install
 
-```sh
-yarn lint
-```
-
-### Type-Check, Compile and Minify for Production
-
-```sh
+# Type-Check, Compile and Minify for Production
 yarn build
-```
 
-### Lint with [ESLint](https://eslint.org/)
+# Compile and Hot-Reload for Development (port 3000)
+yarn start
 
-```sh
+# Lint with [ESLint](https://eslint.org/)
 yarn lint
 ```
-## Project Setup (with docker-compose)
-### Dependencies
-
-1. Install [Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/);
-2. Install [Docker Compose](https://docs.docker.com/compose/install/).
-
-### In the main project folder, build and start the application with the command:
+### Run with docker-compose
 
 ```sh
+# Clone the repo
+git clone https://github.com/liftlearning/P2Pix-Front-End
+cd P2Pix-Front-End
+
+#1. Install [Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/);
+#2. Install [Docker Compose](https://docs.docker.com/compose/install/).
+
+# Run docker-compose up command
 docker-compose up
 ```

src/assets/colored_logo.svg

@@ -0,0 +1,10 @@
+<svg width="259" height="64" viewBox="0 0 259 64" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M127.675 31.868C127.675 42.1048 121.155 49.3558 112.198 49.3558C106.958 49.3558 102.936 46.7966 100.499 43.0188V63.8579H93.6135V15.1114H100.499V20.8392C102.936 17.0004 106.958 14.3802 112.259 14.3802C121.033 14.3802 127.675 21.6313 127.675 31.868ZM120.729 31.868C120.729 25.4701 116.585 20.961 110.736 20.961C104.886 20.961 100.438 25.4701 100.438 31.868C100.438 38.3269 104.886 42.775 110.736 42.775C116.524 42.775 120.729 38.3269 120.729 31.868Z" fill="#14B8A6"/>
+<path d="M165.454 42.0438V48.6246H133.098V43.689L145.468 32.8429C155.034 24.4951 157.471 22.3624 157.471 18.5846C157.471 14.8677 154.607 11.821 149.367 11.821C144.188 11.821 141.324 14.8067 140.41 19.6814H133.464C134.439 10.7851 140.837 5.24023 149.672 5.24023C158.751 5.24023 164.418 11.0898 164.418 18.2799C164.418 24.7388 159.909 28.5776 151.195 36.1942L144.493 41.9829L144.371 42.0438H165.454Z" fill="#F59E0B"/>
+<path d="M206.34 31.868C206.34 42.1048 199.82 49.3558 190.863 49.3558C185.622 49.3558 181.601 46.7966 179.163 43.0188V63.8579H172.278V15.1114H179.163V20.8392C181.601 17.0004 185.622 14.3802 190.924 14.3802C199.698 14.3802 206.34 21.6313 206.34 31.868ZM199.393 31.868C199.393 25.4701 195.25 20.961 189.4 20.961C183.551 20.961 179.103 25.4701 179.103 31.868C179.103 38.3269 183.551 42.775 189.4 42.775C195.189 42.775 199.393 38.3269 199.393 31.868Z" fill="#14B8A6"/>
+<path d="M221.207 4.20438C221.207 6.70263 219.318 8.53062 216.698 8.53062C214.2 8.53062 212.25 6.70263 212.25 4.20438C212.25 1.76706 214.2 0 216.698 0C219.318 0 221.207 1.76706 221.207 4.20438ZM213.286 15.1114H220.171V48.6246H213.286V15.1114Z" fill="#14B8A6"/>
+<path d="M249.785 48.6246L241.681 36.6208L233.881 48.6246H225.594L237.598 31.3806L226.265 15.1115H234.491L241.924 26.3231L249.115 15.1115H257.401L246.068 31.5024L258.011 48.6246H249.785Z" fill="#14B8A6"/>
+<path d="M8.11425 8.12439C11.7804 8.12439 14.8778 10.5617 15.8832 13.9029C19.7423 14.1771 23.4389 15.8527 26.1707 18.6049L40.9165 33.3405C40.9673 33.3913 41.0282 33.4421 41.079 33.503L57.2466 49.6604C59.2168 51.6407 61.9384 52.768 64.721 52.768C64.7312 52.768 64.7413 52.768 64.7515 52.768H65.6452C66.8639 49.8331 69.7582 47.7715 73.14 47.7715C77.6185 47.7715 81.2542 51.4072 81.2542 55.8857C81.2542 60.3643 77.6185 64 73.14 64C69.5246 64 66.4779 61.6439 65.4218 58.3738H64.7617C64.7515 58.3738 64.7312 58.3738 64.721 58.3738C60.4659 58.3738 56.3021 56.6474 53.3063 53.6312L38.4995 38.8245C38.4386 38.7737 38.3675 38.7229 38.3066 38.662L22.1898 22.5452C20.4227 20.768 18.0362 19.6814 15.5379 19.4782C14.2888 22.3421 11.4351 24.3427 8.10409 24.3427C3.63567 24.3427 0 20.7172 0 16.2386C0 11.7601 3.63567 8.12439 8.11425 8.12439Z" fill="#F59E0B"/>
+<path d="M8.11425 47.7715C11.496 47.7715 14.3802 49.8331 15.609 52.768H16.5027C16.5129 52.768 16.523 52.768 16.5332 52.768C19.3259 52.768 22.0476 51.6408 24.0076 49.6605L33.6553 40.0127L37.6058 43.9632L27.948 53.6211C24.9419 56.6373 20.7883 58.3637 16.5332 58.3637C16.523 58.3637 16.5027 58.3637 16.4925 58.3637H15.8324C14.7864 61.6236 11.7296 63.9899 8.11425 63.9899C3.63567 63.9899 0 60.3542 0 55.8756C0 51.397 3.63567 47.7715 8.11425 47.7715Z" fill="#F59E0B"/>
+<path d="M73.1298 24.3427C69.748 24.3427 66.8638 22.2812 65.635 19.3462H64.7413C64.7312 19.3462 64.721 19.3462 64.7109 19.3462C61.9181 19.3462 59.1964 20.4735 57.2364 22.4538L47.5887 32.1016L43.6382 28.1511L53.2961 18.4932C56.3021 15.477 60.4557 13.7506 64.7109 13.7506C64.721 13.7506 64.7413 13.7506 64.7515 13.7506H65.4116C66.4678 10.4805 69.5246 8.1244 73.1298 8.1244C77.6084 8.1244 81.244 11.7601 81.244 16.2387C81.244 20.7172 77.6084 24.3427 73.1298 24.3427Z" fill="#F59E0B"/>
+</svg>