Skip to main content

HSLayers-NG integrated into Wagtail CMS with Codered

Project description

HSLayers-NG map widget for Wagtail CodeRed CMS

Note: Has npm dependency on HSLayers-NG that gets automatically installed into static files. python collectstatic must be executed for the module to correctly locate the HSLayers bundles.


  1. Copy whole codered-hslayers to the Wagtail root to a new folder named 'hslayers'

  2. Add 'hslayers' to the INSTALLED_APPS list in the settings/

    # This project
    # CodeRed CMS
  1. You have three options now:

    • Keep existing CodeRed 'Web Page', 'Article Landing Page' and 'Article Page' untouched and add a new page type 'Web Page Extended', 'Article Landing Page Extended' and 'Article Page Extended' with new widgets of crx_hslayers

      • Run crx_hslayers migrations
      $ python3 makemigrations crx_hslayers
      • Go to point 4
    • Modify existing CodeRed 'Web Page' and/or 'Article Landing Page' and/or 'Article Page' type and add crx_hslayers widgets to it

      • Edit Wagtail's file

        • Add those imports at the top
        from coderedcms.blocks import (
        from django.utils.translation import gettext_lazy as _
        from crx_hslayers import blocks
        from wagtail.core.fields import StreamField
        from wagtail.core.blocks import RawHTMLBlock
        • Replace code of WebPage and/or ArticleIndexPage and/or ArticlePage function with the WebPage2 and/or ArticleIndexPageExtended and/or ArticlePageExtended function code from the crx_hslayers/ file
      • Delete WebPage2 and/or ArticleIndexPageExtended and/or ArticlePageExtended method in the crx_hslayers/ file

      • In case of ArticleIndexPage and ArticlePage overriding, don't forget to modify subpage_types and parent_page_types to your needs. In this particular case delete 'crx_hslayers.ArticlePageExtended' and 'crx_hslayers.ArticleIndexPageExtended' from the code

      parent_page_types = ['website.ArticleIndexPage', 'crx_hslayers.ArticleIndexPageExtended']
      subpage_types = ['website.ArticlePage', 'crx_hslayers.ArticlePageExtended']
      • Go to point 4
    • Use crx_hslayers widgets in any other Wagtail models

      • Take the code of WebPage2 and/or ArticleIndexPageExtended the crx_hslayers/ file and modify it as you wish or use the widgets anywhere else
      • Go to point 4
  2. Install HSLayers app package from npm

cd ./static/hslayers
npm install
  1. Update Wagtail migrations
$ python3 makemigrations
$ python3 migrate
$ python3 collectstatic
  1. Restart Wagtail

  2. New HSLayers blocks are added to the CMS

    • HSLayers map
    • Clima map


Update semantic version of the package

Run test update without commiting

$ bumpver update --patch(--minor|--major) --dry

Run update and commit the changes to the repo

$ bumpver update --patch(--minor|--major)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crx_hslayers-2.1.2.tar.gz (11.5 MB view hashes)

Uploaded Source

Built Distribution

crx_hslayers-2.1.2-py3-none-any.whl (11.7 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page