docs: update

This commit is contained in:
wood911010 committed 2025-08-13 18:17:02 +08:00
1 parent 2ec7f21cb1
commit 8673b539b7
1 file changed
+11 -118
+11 -118
View File
@@ -1,139 +1,32 @@
# Release v0.1.0 - Initial Framework Release
**发布日期**: 2024-08-13
**发布日期**: 2024-08-13
**版本类型**: 初始框架版本
---
## 🎉 首个框架版本发布
这是License Manager项目的第一个发布版本,包含了基础的系统框架和核心功能。该版本主要展示了完整的技术架构和基础功能实现,为后续功能开发奠定了坚实的基础。
这是License Manager项目的第一个发布版本,包含了基础的系统框架和核心功能。
## ✨ 新功能
## ✨ 本版本新增
### 🔐 认证系统
- JWT身份认证机制
- 安全的登录/登出功能
- 会话管理和状态保持
- 认证中间件保护
- 🔐 JWT用户认证系统
- 🌐 多语言支持(中/英/日)
- 📊 响应式管理界面
- 🛠️ 完整的前后端分离架构
- 🐳 Docker容器化部署支持
- 📝 API基础框架
### 🌐 国际化支持
- 多语言框架实现
- 支持中文、英文、日文
- 前后端统一的国际化方案
- 动态语言切换
### 📊 管理界面
- 现代化的响应式设计
- 基于Element Plus的UI组件
- 仪表盘数据展示
- 侧边栏导航系统
- 深色模式支持
### 🛠️ 系统架构
- 完整的前后端分离架构
- RESTful API设计规范
- 结构化错误处理
- 配置管理系统
- 日志记录机制
### 🐳 部署支持
- Docker容器化部署
- Docker Compose编排
- 开发/生产环境配置分离
- 健康检查机制
## 🏗️ 技术栈
### 前端技术
- **框架**: Vue 3.4+ with Composition API
- **语言**: TypeScript 5.0+
- **UI组件**: Element Plus
- **状态管理**: Pinia
- **路由**: Vue Router 4
- **国际化**: Vue I18n 9
- **构建工具**: Vite 5.0+
- **样式**: SCSS
### 后端技术
- **语言**: Go 1.23+
- **框架**: Gin Web Framework
- **ORM**: GORM
- **数据库**: MySQL 8.0+
- **配置**: Viper
- **日志**: Logrus
- **认证**: JWT
### 基础设施
- **容器化**: Docker & Docker Compose
- **反向代理**: Nginx
- **API文档**: Swagger
- **数据库迁移**: 自定义迁移系统
## 📖 快速开始
### 使用Docker部署(推荐)
## 📦 快速体验
```bash
# 克隆项目
git clone https://github.com/cedar-v/license-manager.git
cd license-manager
# 开发环境部署
docker compose up -d --build
# 访问系统
echo "Frontend: http://localhost:18080"
echo "Backend: http://localhost:18888"
echo "Health Check: http://localhost:18888/health"
```
### 本地开发
```bash
# 后端启动
cd backend/cmd
cp ../configs/config.example.yaml ./config.yaml
# 编辑config.yaml配置数据库连接
go build -o license-manager
./license-manager
# 前端启动(新终端)
cd frontend
npm install
npm run dev
```
## 🗂️ 项目结构
```
license-manager/
├── backend/ # Go后端服务
│ ├── cmd/ # 应用入口
│ ├── internal/ # 内部模块
│ ├── pkg/ # 公共包
│ ├── configs/ # 配置文件
│ └── migrations/ # 数据库迁移
├── frontend/ # Vue前端应用
│ ├── src/ # 源代码
│ ├── public/ # 静态资源
│ └── docs/ # 前端文档
├── docs/ # 项目文档
└── scripts/ # 构建脚本
```
## 🔧 配置说明
### 数据库配置
需要MySQL 8.0+数据库,并在`backend/configs/config.yaml`中配置连接信息。
### 环境变量
- `ENV`: 运行环境(development/production)
- `DB_HOST`: 数据库主机
- `DB_PORT`: 数据库端口
- `DB_USER`: 数据库用户名
- `DB_PASS`: 数据库密码
- `DB_NAME`: 数据库名称
访问: http://localhost:18080
## 🔮 下一步计划