我们提供了搭建好的 Dev Container 开发环境，并强烈建议开发者和使用VSCode的初学者使用它。此外，我们也提供了在本地进行环境搭建的方法。
需要安装 Docker 和 VSCode 的 devcontainer 扩展。Linux 用户需要额外安装 docker compose。
在 VSCode 中，将主侧栏视图切换至 远程资源管理器-开发容器，打开项目根目录。若 devcontainer 启动正常，可以看到：
vscode ➜ /workspace
至此，devcontainer 中相当于一个配置好的 Python 环境，并且无需自行配置 MySQL。
容器创建或重建时会自动完成：
- 若不存在则生成 Compose 默认
config.json（库名yppf，主机mysql，密码secret） - 确保开发数据库可用（见下：空库导入样例；已有数据则沿用）
- 安装可选开发依赖（
.devcontainer/dev_requirements.txt，仅postCreate）
数据库初始化由 postCreateCommand / postStartCommand 调用
scripts/devcontainer_ensure_db.sh：
- 库中已有用户数据：提示沿用原有数据库，不会
DROP或重新导入样例； 仅执行migrate - 空库 / 尚无表：执行
migrate→ 导入dev_sample.sql - 不会自动创建 Django 超级管理员；需要访问
/admin/时请自行创建（见下）
注意： 创建/重建容器默认保留 Compose MySQL 卷中已有的
yppf数据。 若需清空并恢复为样例库，请在容器内手动执行：bash scripts/devcontainer_reset_sample_db.sh仅执行宿主机docker compose ... up --build不会跑上述钩子。
开发容器内常用命令：
# 启动网站（须绑定 0.0.0.0 以便宿主机访问）
python manage.py runserver 0.0.0.0:8000
# 需要 Django Admin（/admin/）时，手动创建超级用户（二选一）
python scripts/create_dev_superuser.py
# 默认用户名 admin、密码 secret、显示名 admin；可用参数覆盖：
# python scripts/create_dev_superuser.py --username admin --password secret --name admin
# 或交互式：
python manage.py createsuperuser
# 应用代码迁移（git pull 后如有模型变更）
python manage.py migrate --noinput
# 清空并重新导入样例库（会删除已有数据）
bash scripts/devcontainer_reset_sample_db.sh样例账号密码均为 test（用户名形如 S000001 / P000001 / O000001）。
手动重新导入、重置或导出样例库，见下文 样例数据库。
仓库根目录的 dev_sample.sql 是脱敏后的开发样例数据（INSERT-only）。
Dev Container 在空库时会自动导入；已有数据时沿用原库，不会自动清库。
拉取更新后的 dev_sample.sql 时： Compose MySQL 卷仍保留旧数据，
ensure_db 不会自动重导入。需要吃到上游样例修复时，在容器内执行
bash scripts/devcontainer_reset_sample_db.sh。维护/修改 dump 后建议跑：
python manage.py test dm.test.test_sample_sql_integrity。
约定： 导入顺序必须是 空库 → migrate → 导入 SQL。顺序颠倒会导致
migration / schema 冲突。样例文件路径在容器内为 /workspace/dev_sample.sql。
| 账号形态 | 示例 | 登录入口 | 密码 |
|---|---|---|---|
| 学生 / 自然人 / 组织 | S000001、P000001、O000001 |
网站首页 | test |
| 特殊账号（样例内） | X000001 等 |
/admin/ |
test |
| 开发超级管理员（需手动创建） | 如 admin |
/admin/ |
自定（脚本默认 secret） |
首次登录改密流程已在导出时关闭（is_newuser=false）。
超级管理员不在样例 SQL 中，也不由容器钩子创建；见上文「开发容器内常用命令」。
test -f config.json || bash scripts/default_config.sh
bash scripts/devcontainer_ensure_db.sh已有数据时只会 migrate；空库才会导入样例。不会创建超级用户。
推荐在开发容器内一键重置：
bash scripts/devcontainer_reset_sample_db.sh等价分解步骤：
python scripts/import_dev_sample.py --drop-database
python manage.py migrate --noinput
python scripts/import_dev_sample.py --force重置后如需 /admin/，再手动执行 python scripts/create_dev_superuser.py
或 python manage.py createsuperuser。
--drop-database：清空并重建目标库后退出（会删除已有数据）- 默认读取根目录
dev_sample.sql；库中已有用户时会跳过；加--force会先 TRUNCATE 转储中出现的表再导入（保留 schema，无需先--drop-database） create_dev_superuser.py默认创建/更新admin/secret（可用参数覆盖）- 连接参数默认读取
DB_HOST/DB_USER/DB_PASSWORD/DB_DATABASE（Compose 下为mysql/root/secret/yppf）
指定其它 SQL 文件：
python scripts/import_dev_sample.py --sql /workspace/path/to/other.sql --force也可在宿主机项目根目录用 mysql 客户端清空库：
Linux / macOS：
docker compose -f .devcontainer/docker-compose.yml exec -T mysql \
mysql -uroot -psecret -e \
"DROP DATABASE IF EXISTS yppf; \
CREATE DATABASE yppf CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;"Windows PowerShell：
docker compose -f .devcontainer/docker-compose.yml exec -T mysql `
mysql -uroot -psecret -e `
"DROP DATABASE IF EXISTS yppf; CREATE DATABASE yppf CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;"然后在开发容器内：
python manage.py migrate --noinput
python scripts/import_dev_sample.py --force
# 可选：python scripts/create_dev_superuser.pymigrate 完成后，在宿主机导入根目录文件。
Linux / macOS：
docker compose -f .devcontainer/docker-compose.yml exec -T mysql \
mysql -uroot -psecret yppf < dev_sample.sqlWindows PowerShell：
Get-Content .\dev_sample.sql -Raw -Encoding UTF8 | `
docker compose -f .devcontainer/docker-compose.yml exec -T mysql `
mysql -uroot -psecret yppf| 步骤 | 执行位置 |
|---|---|
docker compose / 清空数据库 |
宿主机 |
ensure_db / reset_sample_db / migrate / 导入脚本 |
开发容器 |
宿主机重定向 < dev_sample.sql |
宿主机 |
在含真实数据的库上（开发容器内）采样导出，再覆盖根目录样例文件：
python manage.py export_sample_db --ratio 0.1 --seed 42 --outdir .
# 将生成的 dev_sample_YYYYMMDD_HHMMSS.sql 复制/重命名为根目录 dev_sample.sql实现见 dm/management/commands/export_sample_db.py
与 dm/sample_db_export.py。请勿对已脱敏样例库再采样后当作正式样例提交。
约定摘要（与导出脚本一致）：
- 活动/反馈相关 URL 一律清空；活动简介与地点为
[redacted] FeedbackType/Feedback中未纳入样本的默认org_id置为NULL（并校正flexible）- 住宿协议仅保留样本用户的签订记录
-
安装Python，在项目根目录启动终端
-
创建虚拟环境
python -m venv .env
其中.env可以是任何名称，该命令将生成.env文件夹作为虚拟环境，请勿重命名该文件夹。
-
激活虚拟环境
-
Windows
> .env\Scripts\activate # 左侧出现(.env)表明成功激活，可通过以下方式检验 (.env) > where python .env\Scripts\python.exe (.env) > py -0p # 安装pylauncher的检验方式 Installed Pythons found by py Launcher for Windows (venv) .env\Scripts\python.exe *
-
Linux/macOS
$ source .env/bin/activate # 左侧出现(.env)表明成功激活，可通过以下方式检验 (.env) $ which python .env/bin/python
-
VSCode快捷激活
确认右下角Python环境切换到虚拟环境，如
3.10.x('.env': venv)，并启动终端
-
-
安装环境依赖
(.env) $ pip install --require-virtualenv -r requirements.txt
-
创建数据库
CREATE DATABASE yppf CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;
-
创建配置文件
我们使用
config.json管理配置项。config_template.json是其完整模板，包含所有可选配置。复制模板并重命名为
config.json，在bash终端中，你也可以运行scripts/default_config.sh。 -
更新数据库配置
配置项 含义 示例 NAME 数据库名称 yppf USER 数据库用户 root PASSWORD 用户密码 （空） HOST 数据库主机 127.0.0.1 PORT 数据库端口 3306 更新配置文件中django的数据库部分，更多配置项请参考各应用的
config.py文件。
在每次拉取项目代码后（包括初次下载），你都需要迁移数据库，使其与模型一致。
-
更新迁移文件
python manage.py makemigrations
这将在每个具有模型的应用的
migrations文件夹生成一些迁移文件，请不要删除它们。如果你怀疑某个应用（即文件夹）没有更新迁移文件，可以手动检查并更新它，直到不再变化：
$ python manage.py makemigrations xxx_app No change detected
-
执行迁移
python manage.py migrate
如果迁移失败，数据库将很可能难以恢复，此时最简单的办法是删库重建，执行
scripts/remove_migrations.sh，并重新进行更新和迁移。
# http://localhost:8000
python manage.py runserver
# http://localhost
python manage.py runserver 80
python manage.py runserver 0:80
python manage.py runserver 127.0.0.1:80
# http://ip:port
python manage.py runserver ip:port执行任意一种命令以启动，直到你以Ctrl-C退出或关闭终端。启动后，便能通过对应网址访问，访问http://localhost:8000试试吧~
-
生产/调试模式
将
YPPF_DEBUG环境变量设置为true以开启调试模式。调试模式便于使用，除非你打算在生产环境部署本项目，否则请设置为调试模式。
-
管理员
Dev Container 不会自动创建超级用户。在容器内运行
python scripts/create_dev_superuser.py（默认admin/secret） 或python manage.py createsuperuser，再访问 http://localhost:8000/admin。样例库内也有特殊账号（如X000001/test）可用于部分后台场景。 -
交互式执行（Django终端）
python manage.py shell
安装IPython后使用更便捷：
pip install ipython --require-virtualenv
-
缺少模块，无法运行：
ModuleNotFoundError: 'module_name'可能因为缺少环境依赖，安装对应模块即可:
pip install module_name --require-virtualenv
如果使用
requirement.txt安装后依然缺少，欢迎提出issue。 -
缺少环境变量，无法运行
通常提示
os.environ找不到键，本项目的生产模式需要设置环境变量以保证安全，请切换到调试模式。 -
无法连接数据库：
django.db.utils.OperationalError: (2003, "Can’t connect to MySQL server on ‘xxx’- 配置错误：检查已经更新数据库配置并正确设置了
config.json - 若
MySQL未启动，请先启动对应服务。
- 配置错误：检查已经更新数据库配置并正确设置了
-
Django配置错误：
ImproperlyConfigured配置文件设置有误，请检查对应配置的config文件并修改。
-
缺少字段：
Unknown column 'xx.xxx' in 'field list'未执行迁移或模型变动未检出，请参考更新和迁移。必要时可以删库重建。
-
样例库：先导入 SQL 再 migrate 报错，或导入时报
Table already exists请按 样例数据库 清空库后执行 migrate → 导入。根目录
dev_sample.sql应为 INSERT-only。 -
import_dev_sample提示 Skip import库中已有用户。确认后加
--force，或执行bash scripts/devcontainer_reset_sample_db.sh清库后重新导入。 Dev Container 创建/重建默认沿用已有数据库，不会自动清库。git pull只更新了dev_sample.sql时同样需要手动 reset 才能刷新本地库。 -
Dev Container 内无法连接 MySQL
确认
mysql服务为healthy；容器内主机应为mysql（环境变量DB_HOST或config.json）。
您可以通过多种方式为本项目做出贡献，例如加入项目组、帮助改进代码或编写文档。即使您对编程一无所知，也能做出有意义的贡献，我们十分欢迎您向我们报告错误或提出改进建议。
若您在使用时遇到错误，或者有设计新功能的想法，请通过issue告诉我们。
若您在使用过程中遇到bug，可以详细描述触发错误的场景和操作，最好保证该错误可以复现。
若在运行代码时发生异常，请在报告中包含错误的traceback上下文信息，并尽量添加该文件的链接，以便查找问题。如有可能，提供能复现错误的代码片段是最直观的方法。
在提出任何建议前，我们希望您能查看是否已有类似提议，避免重复讨论。我们鼓励更具体明确的提案，这比泛泛而谈的交流更高效可行。
您应该使用Git管理代码。fork本仓库，并基于develop分支提交commit，最终提交拉取请求(PR, pull request)。你的任何说明信息都应优先使用中文。
你的 PR 必须满足以下要求，否则将不予受理：
- 标题清晰
- 查找并链接关联issue（如果存在）
- 通过自动化测试：
python manage.py test - 为每个新增接口编写文档
若您的 PR 品质良好，我们会保留您的详细提交信息，并欢迎您成为协作者。
好的 PR 在提交历史、代码质量、PR信息三方面都表现优秀，具体来说有以下特征：
- 线性历史：不含merge commit。若与最新的develop分支冲突，请使用
rebase代替merge。 - 原子化提交：每个commit在功能上不可拆分，而非将大量修改堆砌到同一个commit中。
- 不含零碎修改：极小的修改应该被合并至相关commit中，而非单独提交。
- commit信息有意义且易读
- 符合代码规范，如Google风格指南
- 代码可读性良好，注释和文档数量适宜
- 为新增接口编写测试，并提供导出信息（
__all__） - 同步更新环境说明文件和配置文件
- 为影响他人的改动申请 PR 标签：如删除、模型修改、环境和配置文件修改等。
感谢所有参与本项目的同学们和朋友们，是大家的帮助让 YPPF 越来越好！
如果觉得本项目对你有帮助，帮忙点个 Star 吧 ~