Wagtail Personalisation 项目教程

Wagtail Personalisation 项目教程

wagtail-personalisationRule-based personalisation for Wagtail CMS项目地址:https://gitcode.com/gh_mirrors/wa/wagtail-personalisation

1. 项目的目录结构及介绍

Wagtail Personalisation 项目的目录结构如下：

wagtail-personalisation/
├── wagtail_personalisation/
│   ├── migrations/
│   ├── models/
│   ├── rules/
│   ├── templates/
│   ├── tests/
│   ├── views/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── forms.py
│   ├── middleware.py
│   ├── urls.py
│   └── utils.py
├── docs/
├── example/
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

目录结构介绍

• wagtail_personalisation/: 项目的主要代码目录，包含了所有与 Wagtail Personalisation 相关的代码。
  • migrations/: 存放数据库迁移文件。
  • models/: 存放 Django 模型文件。
  • rules/: 存放个性化规则相关的代码。
  • templates/: 存放模板文件。
  • tests/: 存放测试代码。
  • views/: 存放视图文件。
  • init.py: 初始化文件。
  • admin.py: 管理后台配置文件。
  • apps.py: 应用配置文件。
  • forms.py: 表单配置文件。
  • middleware.py: 中间件配置文件。
  • urls.py: URL 配置文件。
  • utils.py: 工具函数文件。
• docs/: 存放项目文档。
• example/: 存放示例代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍文件。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装配置文件。

2. 项目的启动文件介绍

Wagtail Personalisation 项目的启动文件主要是 manage.py，通常位于项目的根目录下。manage.py 是 Django 项目的管理脚本，用于执行各种管理任务，如启动开发服务器、创建数据库迁移、运行测试等。

启动开发服务器

要启动开发服务器，请在项目根目录下运行以下命令：

python manage.py runserver

这将启动一个本地开发服务器，默认运行在 http://127.0.0.1:8000/。

3. 项目的配置文件介绍

Wagtail Personalisation 项目的配置文件主要包括 settings.py 和 urls.py。

settings.py

settings.py 是 Django 项目的配置文件，包含了项目的所有配置选项。以下是 Wagtail Personalisation 项目中需要特别注意的配置项：

INSTALLED_APPS = [
    # 其他应用
    'wagtail_personalisation',
    'wagtailfontawesome',
    # 'wagtail contrib modeladmin',
]

MIDDLEWARE = [
    # 其他中间件
    'django.contrib.sessions.middleware.SessionMiddleware',
    'wagtail_personalisation.middleware.PersonalisationMiddleware',
]

• INSTALLED_APPS: 添加 wagtail_personalisation 和 wagtailfontawesome 到 INSTALLED_APPS 列表中。
• MIDDLEWARE: 确保 SessionMiddleware 和 PersonalisationMiddleware 已添加到 MIDDLEWARE 列表中。

urls.py

urls.py 是 Django 项目的 URL 配置文件，定义了项目的 URL 路由。以下是 Wagtail Personalisation 项目的 urls.py 示例：

from django.urls import include, path
from wagtail import urls as wagtail_urls
from wagtail.admin import urls as wagtailadmin_urls
from wagtail.documents import urls as wagtaildocs_urls

urlpatterns = [
    path('admin/', include(wagtailadmin_urls)),
    path('documents/', include(wagtaildocs_urls)),
    path('', include(wagtail_urls)),
]

• wagtailadmin_urls: 管理后台的 URL 配置。
• wagtaildocs_urls: 文档管理的 URL 配置。
• wagtail_urls: 主站点的 URL 配置。

通过以上配置，Wagtail Personalisation 项目可以正常启动并运行。

wagtail-personalisationRule-based personalisation for Wagtail CMS项目地址:https://gitcode.com/gh_mirrors/wa/wagtail-personalisation