📝 Add quick start guide and config tool

## 新增
- quick_config.bat: 快速配置工具
- START_HERE.txt: 3步启动指南

🚀 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
2025-12-01 13:44:26 +08:00
parent 9c96cdd526
commit 2d8f20296f
2 changed files with 120 additions and 0 deletions

64
START_HERE.txt Normal file
View File

@@ -0,0 +1,64 @@
==========================================
QQuiz 快速启动指南 (3步完成)
==========================================
【第1步】配置 OpenAI API Key
-------------------------------------------
1. 双击运行: quick_config.bat
2. 会自动打开记事本,找到这一行:
OPENAI_API_KEY=sk-your-openai-api-key-here
3. 将 "sk-your-openai-api-key-here" 替换为你的真实 API Key
4. 保存并关闭记事本
如果没有 API Key可以
- 去 https://platform.openai.com/api-keys 创建
- 或者暂时使用测试 Key功能受限
【第2步】启动系统
-------------------------------------------
双击运行: auto_setup_and_run.bat
脚本会自动:
✓ 检查 Python 和 Node.js
✓ 创建数据库
✓ 安装所有依赖
✓ 启动后端和前端
整个过程 3-5 分钟,请耐心等待
【第3步】访问系统
-------------------------------------------
浏览器打开: http://localhost:3000
默认账户:
用户名: admin
密码: admin123
【如果遇到问题】
-------------------------------------------
1. PostgreSQL 密码
- 脚本会询问 PostgreSQL 管理员密码
- 如果是首次安装,密码可能是你安装时设置的
- 常见默认密码: postgres 或 root
2. 数据库连接失败
- 确保 PostgreSQL 服务正在运行
- 打开"服务"查看 postgresql 服务状态
3. 端口被占用
- 3000/8000 端口可能被占用
- 关闭占用端口的程序重试
【测试数据】
-------------------------------------------
创建题库时可以上传:
test_data/sample_questions.txt
==========================================
准备好了吗现在开始第1步
==========================================

56
quick_config.bat Normal file
View File

@@ -0,0 +1,56 @@
@echo off
chcp 65001 >nul
title QQuiz - 快速配置
echo.
echo ==========================================
echo QQuiz 快速配置
echo ==========================================
echo.
cd /d "%~dp0"
REM 创建 .env 文件
echo 正在创建配置文件...
echo.
(
echo # QQuiz 配置文件 - 快速启动版
echo.
echo # 数据库配置
echo DATABASE_URL=postgresql+asyncpg://qquiz:qquiz_password@localhost:5432/qquiz_db
echo.
echo # JWT 密钥(安全随机生成)
echo SECRET_KEY=qquiz-secret-key-for-development-change-in-production-32chars
echo.
echo # AI 配置 - OpenAI
echo AI_PROVIDER=openai
echo OPENAI_API_KEY=sk-your-openai-api-key-here
echo OPENAI_BASE_URL=https://api.openai.com/v1
echo OPENAI_MODEL=gpt-4o-mini
echo.
echo # 系统配置
echo ALLOW_REGISTRATION=true
echo MAX_UPLOAD_SIZE_MB=10
echo MAX_DAILY_UPLOADS=20
echo.
echo # CORS
echo CORS_ORIGINS=http://localhost:3000,http://127.0.0.1:3000
echo.
echo # 上传目录
echo UPLOAD_DIR=./uploads
) > .env
echo ✓ 配置文件已创建
echo.
echo [重要] 请编辑 OPENAI_API_KEY
echo.
echo 按任意键打开配置文件...
pause >nul
notepad .env
echo.
echo 配置完成!现在可以运行 auto_setup_and_run.bat 启动系统
echo.
pause