snsd0805/Credit-Card-System-web
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
snsd0805 2023-06-12 22:49:51 +08:00
parent 88a9f0d708
commit ce989e07a2
Signed by: snsd0805
GPG Key ID: 569349933C77A854
2 changed files with 56 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.env.example
View File

@ -1,2 +1,5 @@
VITE_CHAIN_ID = VITE_CHAIN_ID =
VITE_SBT_ADDR = VITE_SBT_ADDR =
VITE_BANK_ADDR =
VITE_BACKEND_PREFIX =
VITE_FRONTEND_PREFIX =

66
README.md
View File

@ -1,6 +1,12 @@
# Final-web # Credit-Card-System-web
This template should help get you started developing with Vue 3 in Vite. It's final project for 1112 NCNU CSIE "Principles and Practice of Blockchains"
We have implemented a Crypto Credit Card System, and this repository focuses on the web interface part.
However, many functions have not been fully implemented, and there are still numerous security issues that need to be addressed.
Additionally, You can find smart contract [here]()
## Recommended IDE Setup ## Recommended IDE Setup
@ -10,20 +16,52 @@ This template should help get you started developing with Vue 3 in Vite.
See [Vite Configuration Reference](https://vitejs.dev/config/). See [Vite Configuration Reference](https://vitejs.dev/config/).
## Project Setup ## Project Setup (Frontend)
```sh 1. Deploy the contracts in the [smart contract repo]()
npm install 2. clone this repo
``` ```
git clone $THIS_REPO_LINK
```
3. Install the project dependencies
```
cd Credit-Card-System-web
npm install
```
4. Copy `.env.example` to `.env`, and edit your configurations.
```
cp .env.example .env
vim .env
```
### Compile and Hot-Reload for Development ```
VITE_CHAIN_ID = the ID of the blockchain which you deployed, like 0x539(5173) is for Ganache
VITE_SBT_ADDR = SBT contract's address
VITE_BANK_ADDR = Bank contract's address
VITE_BACKEND_PREFIX = Your backend server's prefix url: like http://192.168.0.102:5000
VITE_FRONTEND_PREFIX = You frontend's prefix: like http://192.168.0.112:5173
```
5. Compile and Hot-Reload for Development
```
npm run dev
```
```sh or you can Minify for Production
npm run dev
```
### Compile and Minify for Production ```
npm run build
```
```sh ## Project Setup (Backend)
npm run build
``` 1. Run backend api server
```
cd Credit-Card-System-web/backend
python main.py
```
## Usage
After setting up the frontend and backend servers, you can open your browser and access the frontend page.
Once the page is loaded, you can connect your MetaMask wallet and proceed to register and log in to the application.