django-cjkcms 0.1.1

Wagtail Content Management System, installable as a Django app into any Wagtail 3.x site. Based on Codered CRX.

CMS system for Wagtail 3.x forked from and based on Wagtail CRX/Wagtail CMS by CodeRed.

Rationale

The rationale behind CjkCMS and the key differences between CjkCMS and CRX are:

• CjkCMS can be installed as a new app onto an existing Wagtail website. CRX expects you to set up a new Wagtail site with the CMS suppport enabled.
• CjkCMS removed from CRX some features that we do not find useful (i.e. features that we have not used even once over the last 18+ months), for example: Content Walls, Locations, Events, FlexForms.
• CjkCMS adds new features not present in CRX, e.g. support for protected (domain-locked) Vimeo files, support for both plain Bootstrap5 and MDBootstrap5, as well as Django-Webpack-Boilerplate

CodeRed CRX is a fantastic piece of software, with great documentation, and our modified fork would not be possible without it. Thank you!

Early Access & limited documentation

One thing that CjkCMS currently lacks is a good documentation - it is a work in progress.

Out of the box, CjkCMS provides your project with generic, reusable pages: ArticleIndex, Article, WebPage which you can use in your project, or extend with additional functionality. CjkCMS pages provide you with a generic "body" section and, using wagtail-seo package, a basic SEO functionality.

Quick install & usage

Note: See helper scripts boot_django.py and boot_urls.py in the Github repository for a preview of how the setup can be configured.

• (optional) If you are staring a new project, install Django 4.x, Wagtail 3.x, and start a new Wagtail project.
• Install the CjkCMS:

pip install django-cjkcms

• Install required packages:

# requirements for cjkcms:
django-bootstrap5
unidecode
django-phonenumber-field[phonenumberslite]
wagtail-cache
wagtail-seo

• Add CjkCMS and its requirements to INSTALLED_APPS in your project configuration (e.g. base.py):

INSTALLED_APPS = [
    ...
    ### django-cjkcms ###
    "cjkcms",
    ### django-cjkcms requirements ###
    "wagtailseo",
    "wagtailcache",
    "wagtail.contrib.table_block",
    "wagtail.contrib.settings",
    "wagtail.contrib.modeladmin",
    "django_bootstrap5",
    ### end django-cjkcms ###
    "django_bootstrap5,
    "wagtail.contrib.sitemaps",
    "django.contrib.sitemaps",

• Run migrations:

python manage.py migrate

• Add cjkcms.urls to urls.py in your project:

from cjkcms import urls as cjkcms_urls

urlpatterns = [
    ...
    # add cjkcms urls
    path("", include(cjkcms_urls)),

    # comment out the default wagtail search view,
    # it will be replaced by the cjkcms search view
    # path("search/", search_views.search, name="search"),
    ...
]

Optional setup steps

• Add concrete models: WebPage, ArticlePage, and ArticleIndexPage to your project, anywhere you want, e.g. in /home/models.py. This will make the new page types visible in the admin panel. This step will provide you with a quick-start to put content into your new website in the admin panel, without further coding. If you skip this step, you need to create your own custom page types and models. You may use the three models in cjkcms.models.cms_models as a starting point.

# e.g. home/models.py
from cjkcms.models.cms_models import ArticleIndexPage, ArticlePage, WebPage

Migrating the homepage:

By default, Wagtail adds a homepage inherited from Page.

Change to WebPage model:

If you are starting a new website, you may want to replace it with CjkCMS WebPage, for the additional functionality provided by CjkCMS.

To do this, you need to:

• log in to the wagtail admin
• go to Pages
• add a new page (any CjkCMS page type, e.g. most generic WebPage) at the top level, next to the Homepage
• go to Settings -> Sites and change the root page of your site to the new CMS page
• go back to pages, if there is no custom content in the default (old) homepage, you can delete it.

Old Homepage cleanup

You cannot remove the HomePage model from home/models.py - first you need to delete that page in the admin panel - see section above. A safer solution is to keep the HomePage model, bug deactivate it by adding max_count = 0 to the Homepage model, which effectively hides it from admin interface.

In /home/models.py change this:

class HomePage(Page):
    pass

to that:

class HomePage(Page):
    max_count = 0

Contact & support

Please use Github's Issue Tracker to report bugs, request features, or request support.