These CKAN Versions are exactely matched:

• 2.10.0
• 2.10.1
• 2.10.2
• 2.10.3
• 2.10.4
• 2.10.5
• 2.10.6
• 2.10.7
• 2.10.8
• 2.10.9
• 2.11.0
• 2.11.1
• 2.11.2
• 2.11.3
• 2.11.4
• 2.12.0
• 2.9.0
• 2.9.0a
• 2.9.1
• 2.9.10
• 2.9.11
• 2.9.13
• 2.9.2
• 2.9.3
• 2.9.4
• 2.9.5
• 2.9.6
• 2.9.7
• 2.9.8
• 2.9.9

ckanext-portaljs-improvements

This extension has one purpose, to allow the use of On demand Incremental Static Regeneration (On demand ISR) on Portal.JS websites.

NextJS has three ways of fetching data: client fetching, ServerSideRendering and StaticSite Generation (SSG).

• Client fetching allows us to send the skeleton of the page quickly, and then populate it with information using javascript. That has a lot of problems: the SEO gets considerably affected, there is also the problem of layout shifting, and the browsers can’t cache the pages easily.
• Serverside rendering has the advantages of SEO, no layout shifting and easier caching, but we need to wait for all the data to be fetched to show something on the screen.
• StaticSite Generation builds pages ahead of time, fetches all the data, injects that data into the html. This makes page loads super fast. But pages are only built once during deploy.

On demand ISR solves these problems. The data source informs the frontend that data has been updated, then the frontend rebuilds only the affected pages. This extension makes the CKAN backend aware of the existence of a PortalJS website, so after every update/create process, the corresponding pages get updated.

Requirements

Installation

1. Activate your CKAN virtual environment.

2. Clone the source and install:

   git clone https://github.com/datopian/ckanext-portaljs-improvements.git
   cd ckanext-portaljs-improvements
   pip install -e .
   pip install -r requirements.txt
   

3. Add portaljs_improvements to the ckan.plugins setting in your CKAN config file.

4. Restart CKAN.

Config settings

None at present.

License

AGPL-3.0