mirror of
https://github.com/Cccc-owo/CheckInApp.git
synced 2026-06-17 05:56:29 +00:00
d4d6f87730
BREAKING CHANGE: root backend/frontend directories and old run/manage entrypoints were removed. Use apps/backend, apps/frontend, and python main.py commands instead.
78 lines
1.6 KiB
Markdown
78 lines
1.6 KiB
Markdown
# CheckIn App V2
|
|
|
|
[](https://fastapi.tiangolo.com/)
|
|
[](https://vuejs.org/)
|
|
[](https://www.python.org/)
|
|
|
|
接龙自动打卡系统,通过 QQ 登录实现每日自动考勤提交。
|
|
|
|
## 特性
|
|
|
|
- QQ 扫码登录
|
|
- 用户任务分离(一人多任务)
|
|
- 任务模板系统
|
|
- 定时自动打卡
|
|
- 邮件通知
|
|
- 用户审批机制
|
|
- 管理后台
|
|
|
|
## 技术栈
|
|
|
|
**后端**: FastAPI + SQLAlchemy + APScheduler + Selenium
|
|
**前端**: Vue 3 + Ant Design Vue + Pinia
|
|
**数据库**: SQLite
|
|
|
|
## 快速开始
|
|
|
|
### 环境要求
|
|
|
|
- Python 3.9+
|
|
- Node.js 16+
|
|
- Chrome 浏览器
|
|
|
|
### 安装运行
|
|
|
|
```bash
|
|
# 后端
|
|
python -m venv venv
|
|
venv\Scripts\activate # Windows
|
|
source venv/bin/activate # Linux/Mac
|
|
pip install -r apps/backend/requirements.txt
|
|
python main.py backend
|
|
|
|
# 前端
|
|
cd apps/frontend
|
|
npm install
|
|
npm run dev
|
|
|
|
# 创建管理员
|
|
PYTHONPATH=apps python apps/backend/scripts/create_admin.py
|
|
```
|
|
|
|
### 访问地址
|
|
|
|
- 前端: <http://localhost:3000>
|
|
- API 文档: <http://localhost:8000/docs>
|
|
|
|
## 进程管理
|
|
|
|
```bash
|
|
python main.py backend-daemon
|
|
python main.py frontend-daemon
|
|
python main.py status
|
|
python main.py stop [all|backend|frontend]
|
|
python main.py frontend-build
|
|
```
|
|
|
|
## 配置
|
|
|
|
复制 `.env.example` 到 `.env`
|
|
|
|
nginx 与 systemd 的配置文件参考已给出,见 `.example`
|
|
|
|
## 文档
|
|
|
|
- [架构设计](docs/architecture.md)
|
|
- [部署指南](docs/deployment.md)
|
|
- [开发指南](docs/development.md)
|