Skip to content

Klimaat-Helpdesk/wagtail-helpdesk

Repository files navigation

Wagtail helpdesk

This repository holds the code for wagtail-helpdesk, a Wagtail app aimed at answering questions by experts. The original implementation was done for Klimaathelpdesk, a website aimed at answering questions regarding climate change, global warming, and related.

License PyPI version wagtail-helpdesk CI

Links

Supported versions

  • Python 3.9, 3.10, 3.11
  • Django 4.2 LTS
  • Wagtail 5.2 LTS

Installation

  • Install the wagtail-helpdesk package:

    $ pip install wagtail-helpdesk

  • Add the wagtail-helpdesk apps to your INSTALLED_APPS in your project's settings.py:

      INSTALLED_APPS = [
          "wagtail_helpdesk",
          "wagtail_helpdesk.cms",
          "wagtail_helpdesk.core",
          "wagtail_helpdesk.experts",
          "wagtail_helpdesk.utils",
          "wagtail_helpdesk.volunteers",
          # Add all wagtail apps according to wagtail docs
          ...
          # Add wagtail routable page contrib module
          "wagtail.contrib.routable_page",
      ]
  • Add the wagtail_helpdesk urls to your project's urls.py:

    from wagtail_helpdesk.urls import urlpatterns as helpdesk_urlpatterns
    
    urlpatterns += [
        ...
        path("", include(wagtail_urls)),
        path("", include(helpdesk_urlpatterns)),
    ]
  • Run Django migrations to create the database tables:

    $ python manage.py migrate