Selaa lähdekoodia

docs: update README with Wails startup and usage instructions

lq 1 kuukausi sitten
vanhempi
commit
70c40bf284
1 muutettua tiedostoa jossa 70 lisäystä ja 15 poistoa
  1. 70 15
      README.md

+ 70 - 15
README.md

@@ -1,34 +1,89 @@
-### 项目运行
+# 智慧停车管理系统 (Smart Parking)
 
+基于 Wails v2 构建的单进程桌面应用。
 
+## 技术栈
 
-#### 前端
+- **桌面框架**:Wails v2.13
+- **后端**:Go 1.25 + Gin + GORM + Casbin + JWT
+- **前端**:Vue 3 + Vite 4 + Element Plus + Pinia
+- **数据库**:MySQL 5.7+(外部)
 
-```cmd
-npm i
-或
-pnpm i
-或
-cnpm i
+## 环境要求
 
-npm run server
+- Go >= 1.25
+- Node.js >= 16
+- MySQL 5.7+
+- Wails CLI
+- Windows 10 build 1809+(WebView2 运行时)
+
+## 安装 Wails CLI
+
+```bash
+go install github.com/wailsapp/wails/v2/cmd/wails@latest
 ```
 
+## 初始化数据库
 
+```bash
+mysql -uroot -proot -e "CREATE DATABASE IF NOT EXISTS lc_garage DEFAULT CHARSET utf8mb4 COLLATE utf8mb4_general_ci;"
+mysql -uroot -proot lc_garage < lc_garage.sql
+```
 
-#### 后端
+修改 `config.yaml` 中的数据库连接信息(默认 `root/root@127.0.0.1:3306/lc_garage`)。
 
+## 安装依赖
 
+```bash
+# 安装前端依赖
+cd frontend && npm install && cd ..
 ```
-创建数据库    执行lc_basic_framework.sql
+
+## 开发模式
+
+```bash
+cd lc_garage
+wails dev
+```
+
+Wails 自动:
+1. 编译 Go 后端,Gin 在 goroutine 中启动(:8888)
+2. 启动 Vite 开发服务器(:5173)
+3. 打开 WebView2 窗口,支持热更新
+
+## 生产构建
+
+```bash
+cd lc_garage
+wails build
 ```
 
-[lc_basic_framework.sql](.\lc_basic_framework.sql) 
+产物:`build/bin/smart-parking.exe`,需与 `config.yaml` 同目录。
+
+## 管理员账户
+
+- 账号:`admin`
+- 密码:`123456`
 
+## 项目结构
+
+```
+lc_garage/
+├── main.go            # Wails 入口
+├── wails.json         # Wails 配置
+├── config.yaml        # 后端配置
+├── server/            # Go 后端
+├── frontend/          # Vue 3 前端
+└── build/bin/         # 构建产物
+```
 
-#### 管理员账户
+## 常见问题
 
-账号: admin
+**双击 exe 打不开?**
+确保 `config.yaml` 与 `smart-parking.exe` 在同一目录。
 
-密码: 123456
+**接口报 404?**
+检查 MySQL 是否运行,确认 `lc_garage` 数据库已初始化。
 
+**wails dev 卡住?**
+确保 `cd frontend && npm install` 已执行过。