Kamixitong/README.md
2025-11-16 19:56:14 +08:00

148 lines
3.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 软件授权管理系统 (KaMiXiTong)
一款基于Python Flask的软件授权管理系统支持卡密生成、设备绑定、在线验证等功能。
## 功能特性
- 🎯 **卡密管理**: 支持批量生成、导入导出卡密
- 🔐 **设备绑定**: 防止账号共享,支持解绑操作
- 🔄 **在线验证**: 实时验证卡密有效性
- 📊 **数据统计**: 可视化展示激活趋势和统计数据
- 🛡️ **安全防护**: AES加密传输防抓包破解
- 🌐 **多产品支持**: 一个系统管理多个软件产品
- 📱 **响应式界面**: 支持PC和移动设备访问
## 目录结构
```
KaMiXiTong/
├── app/ # Web管理后台
│ ├── models/ # 数据模型
│ ├── api/ # API接口
│ ├── web/ # Web界面
│ └── utils/ # 工具函数
├── tests/ # 测试文件
│ ├── __init__.py
│ ├── test_validator.py # 验证器测试
│ ├── test_api.py # API测试
│ └── test_models.py # 模型测试
├── docs/ # 文档
│ ├── INTEGRATION.md # 集成文档
│ ├── EXAMPLES.md # 使用示例
│ └── FASTAPI.md # FastAPI接口文档
├── migrations/ # 数据库迁移文件
│ └── init.sql
└── static/ # 静态文件
```
## 使用方式
### 快速开始 (SQLite)
```bash
# 克隆项目
git clone https://github.com/yourusername/kamaxitong.git
# 进入项目目录
cd kamaxitong
# 安装依赖
pip install -r requirements.txt
# 初始化SQLite数据库
python init_db_sqlite.py
# 启动服务
python run.py
```
访问地址: http://localhost:5000
默认账号: admin / admin123
### MySQL数据库支持
系统也支持使用MySQL数据库提供更好的性能和并发支持。
#### 初始化MySQL数据库
```bash
# 安装MySQL依赖
pip install PyMySQL
# 配置数据库连接
# 复制 .env.example 为 .env 并修改 DATABASE_URL 配置
cp .env.example .env
# 编辑 .env 文件设置MySQL连接信息
# DATABASE_URL=mysql+pymysql://用户名:密码@主机:端口/数据库名
# 初始化MySQL数据库
python init_db_mysql.py
```
或者使用配置脚本:
```bash
# 使用配置脚本自动创建数据库和表
python setup_mysql.py
```
详细配置说明请参考 [MySQL配置指南](MYSQL_CONFIG_GUIDE.md)
### FastAPI接口
系统还提供了现代化的FastAPI接口具有自动生成的交互式文档
```bash
# 安装FastAPI依赖
pip install -r requirements-fastapi.txt
# 启动FastAPI服务
python fastapi_app.py
```
FastAPI文档地址: http://localhost:8000/docs
## 部署说明
### 开发环境
```bash
python start.py
```
### 生产环境
```bash
# 使用一键部署脚本(推荐)
python deploy.py --setup-service --setup-nginx
# 或者手动部署
pip install gunicorn
gunicorn -w 4 -b 0.0.0.0:5000 run:app
# 使用Nginx反向代理
# 配置SSL证书
# 设置防火墙规则
```
## 技术栈
- 后端: Flask + SQLAlchemy
- 前端: Bootstrap 5 + jQuery
- 数据库: SQLite/MySQL
- 部署: Gunicorn + Nginx
## 文档
为了更好地管理和使用项目文档,请参考 [文档整理指南](DOCUMENTATION_GUIDE.md)。
- [集成指南](docs/INTEGRATION.md)
- [使用示例](docs/EXAMPLES.md)
- [FastAPI接口文档](docs/FASTAPI.md)
- [部署说明](docs/DEPLOYMENT.md)
- [MySQL配置指南](MYSQL_CONFIG_GUIDE.md)
## 许可证
MIT License