infrascielo/oca_django

Template SCMS

针对SciELO上下文的内容管理通用模板项目。

https://img.shields.io/badge/code%20style-black-000000.svg](https://github.com/ambv/black)

许可证：GPLv3

镜像概述和主要用途

Template SCMS是一个为SciELO上下文设计的内容管理系统通用模板，提供完整的Docker化开发环境和标准化操作流程。该镜像旨在简化内容管理系统的开发、部署和维护过程，支持多语言内容管理、页面树构建、菜单配置等核心功能，适用于构建科学文献相关的内容管理平台。

核心功能和特性

• Docker化开发环境：通过Docker Compose实现环境一致性，支持开发和生产环境配置分离
• 便捷命令集：提供Makefile封装常用操作，简化项目构建、启动、测试等流程
• 多语言支持：集成Wagtail翻译同步功能，支持新增语言后的页面和菜单同步
• 内容管理功能：支持页面树创建、菜单配置、数据源管理等核心CMS功能
• 数据库管理：提供数据库迁移、备份、恢复等完整数据操作支持
• 开发工具集成：包含代码风格检查（Black）、类型检查（mypy）、测试覆盖率分析等开发工具

使用场景和适用范围

• 开发SciELO相关的内容管理系统
• 构建多语言科学文献内容平台
• 需要快速搭建标准化CMS开发环境的项目
• 需支持页面树管理和菜单配置的Web应用开发

详细使用方法和配置说明

开发环境启动与操作

项目提供Makefile封装常用命令，可通过以下方式查看所有可用命令：

bash
make help

命令列表及说明：

bash
Usage: make [target] [argument] ...

Argument:
    compose = {compose_file_name}

    targets:

    help                                           显示帮助信息
    app_version                                    显示Web应用版本
    vcs_ref                                        显示最后提交的引用
    build_date                                     显示构建日期
    build                              使用$(COMPOSE_FILE_DEV)构建应用
    up                                 使用$(COMPOSE_FILE_DEV)启动应用
    logs                               使用$(COMPOSE_FILE_DEV)查看所有应用日志
    stop                               使用$(COMPOSE_FILE_DEV)停止所有应用
    ps                                 使用$(COMPOSE_FILE_DEV)查看所有容器
    rm                                 使用$(COMPOSE_FILE_DEV)移除所有容器
    django_shell                       从Django容器打开Python终端（使用$(COMPOSE_FILE_DEV)）
    wagtail_sync                       Wagtail同步页面字段（每次添加新语言或更新页面翻译时执行）
    wagtail_update_translation_field   Wagtail更新翻译字段（需先执行此命令）
    django_createsuperuser             创建Django超级用户
    django_bash                        从Django容器打开bash终端
    django_test                        运行Django容器中的测试
    django_fast                        快速运行Django容器中的测试
    django_makemigrations              运行Django数据库迁移文件生成
    django_migrate                     运行Django数据库迁移
    django_add_pages                   使用core/fixtures/pages.json创建页面
    django_add_menus                   使用core/fixtures创建菜单
    django_add_sources                 运行数据源添加命令
    django_makemessages                运行makemessages命令
    django_compilemessages             运行compilemessages命令
    django_dump_auth                   导出auth数据
    django_load_auth                   导入auth数据
    dump_data                          将数据库导出为.sql文件
    restore_data                       从latest.sql文件恢复数据库

构建开发环境

使用以下命令构建开发环境栈：

bash
make build compose=local.yml

等同于：

bash
make

启动项目

bash
make up

停止项目

bash
make stop

注：项目栈配置了2个Docker Compose文件，分别用于开发环境（local.yml）和生产环境（production.yml）。可通过compose参数指定使用的配置文件。

本地环境初始化流程（Big Bang）

对于全新的本地环境，按以下顺序执行命令：

bash
make build
make up
make django_migrate
make django_add_sources
make django_add_pages
make django_add_menus
make django_createsuperuser

各步骤说明：

• make django_add_sources：创建或更新搜索页面使用的数据源
• make django_add_pages：从core/fixtures/pages.json创建页面树，包括必要的翻译主页
• make django_add_menus：从core/fixtures中的数据创建菜单

若后续添加或修改语言，需执行：

bash
make wagtail_sync
make django_add_pages
make django_add_menus

清理数据库迁移

停止项目

bash
make stop

查找并删除迁移脚本

bash
find . -path "*/migrations/*.py" -not -name "__init__.py" -not -path "./core/*" -delete
find . -path "*/migrations/*.pyc"  -delete

删除数据库文件（PostgreSQL）

bash
cd ..
rm -rf scms_data
cd -

重启项目

bash
make up

重新生成并应用迁移

bash
make django_makemigrations
make django_migrate

数据库即时备份

bash
docker exec -t oca_local_postgres pg_dumpall -c -U GVRFlLmcCNfGLhsFvSnCioYOPJPYpyfj > oca.sql

数据库即时恢复

bash
cat oca.sql | docker exec -i oca_local_postgres psql -U GVRFlLmcCNfGLhsFvSnCioYOPJPYpyfj core

基本命令

用户设置

• 创建普通用户：通过注册表单创建，提交后会收到邮件验证链接（开发环境中查看控制台输出）
• 创建超级用户：

  bash
  python manage.py createsuperuser
  

类型检查

使用mypy进行类型检查：

bash
mypy core

测试覆盖率

运行测试并生成覆盖率报告：

bash
coverage run -m pytest
coverage html
open htmlcov/index.html

使用pytest运行测试

bash
pytest

Celery

项目集成Celery，启动Celery worker：

bash
cd core
celery -A config.celery_app worker -l info

注意：需在包含manage.py的目录中运行Celery命令

邮件服务器

开发环境中集成MailHog作为本地SMTP服务器，启动所有Docker容器后自动运行。通过以下地址查看发送的邮件：

http://127.0.0.1:8025

Sentry

Sentry是错误日志聚合服务，支持404日志和WSGI应用集成。生产环境中需设置DSN URL。

部署

Docker部署

详见http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html%E3%80%82

设置

详见http://cookiecutter-django.readthedocs.io/en/latest/settings.html%E3%80%82