From 470f927a6d51de1b22aea786db60c68dd9144c38 Mon Sep 17 00:00:00 2001 From: RcleydsonR Date: Wed, 4 Jan 2023 16:54:54 -0300 Subject: [PATCH] Improve readme --- README.md | 67 +++++++++++++++++++++++-------------- src/assets/colored_logo.svg | 10 ++++++ 2 files changed, 52 insertions(+), 25 deletions(-) create mode 100644 src/assets/colored_logo.svg diff --git a/README.md b/README.md index 909dd1d..60c4f6e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,19 @@ -# P2Pix-Front-End +

+ Logo P2Pix +

+
-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 ``` diff --git a/src/assets/colored_logo.svg b/src/assets/colored_logo.svg new file mode 100644 index 0000000..d86c891 --- /dev/null +++ b/src/assets/colored_logo.svg @@ -0,0 +1,10 @@ + + + + + + + + + +