mirror of
https://github.com/Cccc-owo/CheckInApp.git
synced 2026-06-17 05:56:29 +00:00
8a12744
3ab845798d
Add a lightweight migration runner with schema_migrations tracking, run pending migrations during backend startup before the scheduler, and keep a manual backend-migrate entrypoint. The change also moves the existing lockout and task-thread-ID schema steps into shared migration modules, updates docs, and archives the OpenSpec change.
94 lines
2.1 KiB
Markdown
94 lines
2.1 KiB
Markdown
# CheckIn App V2
|
|
|
|
[](https://fastapi.tiangolo.com/)
|
|
[](https://vuejs.org/)
|
|
[](https://www.python.org/)
|
|
|
|
接龙自动打卡系统，通过 QQ 登录实现每日自动考勤提交。
|
|
|
|
## 特性
|
|
|
|
- QQ 扫码登录
|
|
- 用户任务分离（一人多任务）
|
|
- 任务模板系统
|
|
- 定时自动打卡
|
|
- 邮件通知
|
|
- 用户审批机制
|
|
- 管理后台
|
|
|
|
## 技术栈
|
|
|
|
**后端**: FastAPI + SQLAlchemy + APScheduler + Playwright
|
|
**前端**: Vue 3 + TypeScript + shadcn-vue + Tailwind
|
|
**数据库**: SQLite
|
|
|
|
## 快速开始
|
|
|
|
### 环境要求
|
|
|
|
- Python 3.12+
|
|
- uv
|
|
- Node.js 20+
|
|
- pnpm
|
|
- Chrome 浏览器
|
|
|
|
### 安装运行
|
|
|
|
```bash
|
|
# 后端
|
|
uv sync
|
|
uv run playwright install chromium
|
|
uv run python main.py backend
|
|
|
|
# 手动执行数据库迁移（后端启动时也会自动执行）
|
|
uv run python main.py backend-migrate
|
|
|
|
# 前端
|
|
cd apps/frontend
|
|
pnpm install
|
|
pnpm dev
|
|
|
|
# 创建管理员
|
|
uv run python apps/backend/scripts/create_admin.py
|
|
```
|
|
|
|
### Docker Compose 部署
|
|
|
|
生产环境推荐使用 Docker Compose。主机只需要 Docker/Compose，不需要单独安装 Python、Node.js、pnpm 或 Chromium。
|
|
|
|
```bash
|
|
cp deploy/compose.env.example .env
|
|
# 编辑 .env，至少修改 SECRET_KEY、CORS_ORIGINS、FRONTEND_URL
|
|
docker compose up -d --build
|
|
```
|
|
|
|
默认访问地址：<http://localhost:8080>
|
|
|
|
### 访问地址
|
|
|
|
- 前端: <http://localhost:3000>
|
|
- API 文档: <http://localhost:8000/docs>
|
|
|
|
## 进程管理
|
|
|
|
```bash
|
|
uv run python main.py backend-daemon
|
|
uv run python main.py backend-migrate
|
|
python main.py frontend-daemon
|
|
python main.py status
|
|
python main.py stop [all|backend|frontend]
|
|
python main.py frontend-build
|
|
```
|
|
|
|
## 配置
|
|
|
|
复制 `.env.example` 到 `.env`
|
|
|
|
Docker Compose 环境变量参考 `deploy/compose.env.example`。nginx 与 systemd 的传统部署配置文件参考已给出，见 `.example`
|
|
|
|
## 文档
|
|
|
|
- [架构设计](docs/architecture.md)
|
|
- [部署指南](docs/deployment.md)
|
|
- [开发指南](docs/development.md)
|