From a31e8ce7768c2edd4c132eebf317adf334c8aa8c Mon Sep 17 00:00:00 2001
From: SoulGateKey <soulgatekey@gmail.com>
Date: Sat, 5 Oct 2024 08:25:03 +0800
Subject: [PATCH] add README.md

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a3fd7df
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Mai2Frontend
+## How to use?
+
+### Prepare
+- Rename config_example.yaml to config.yaml
+- Fill in your artemis database ip and password
+- go frontend/ and run 
+ 
+'npm install' 
+
+'npm install vite@latest --save-dev' 
+
+'npm install @vitejs/plugin-vue --save-dev'
+'
+### Run
+- run ./backend/app.py as backend. If you need,change the flusk ip and port in config.yaml and App.vue
+- run 'npm run dev' in frontend/
+- Remember to install all the need dependencies
+
+## WIP