https://github.com/datopian/ckanext-datapub
CKAN extension to integrate your custom DataPub.js based dataset and resource editor
https://github.com/datopian/ckanext-datapub
Last synced: 6 months ago
JSON representation
CKAN extension to integrate your custom DataPub.js based dataset and resource editor
- Host: GitHub
- URL: https://github.com/datopian/ckanext-datapub
- Owner: datopian
- License: agpl-3.0
- Created: 2020-10-08T14:17:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-07-26T01:41:01.000Z (8 months ago)
- Last Synced: 2025-08-16T10:50:32.693Z (8 months ago)
- Language: Shell
- Size: 18.2 MB
- Stars: 5
- Watchers: 11
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Enable Datapub apps in your CKAN instance.
Find out about Datapub here - https://github.com/datopian/datapub.
## Installation
Just follow standard procedure for setting up an extension for the CKAN and add `datapub` into list of the plugins. Note that this extension supports CKAN 2.8 onwards.
## Building and publishing the datapub app
To build the datapub React app we use the `sync.sh` script. This script will
1. Clone (or copy from a local folder) the datapub app source
2. Install its dependencies and create the production build
3. Update the asset references in the CKAN templates so they include the built application
The `sync.sh` accepts the following parameters:
sync.sh [] [] []
* `` can be a Git URL or the path to a local datapub repository. Defaults to https://github.com/datopian/datapub
* `` is the git tag or branch that you want to build. Defaults to `master`
* `` is used to target CKAN<=2.8 (using `resources`) or CKAN>=2.9 (using `webassets`). Defaults to `webassets`.
For example, to build a released tag of a custom datapub repo:
./sync.sh https://github.com/datopian/datapub v0.1.2
Same, but targetting CKAN 2.8:
./sync.sh https://github.com/datopian/datapub v0.1.2 resources
To build a local development clone of datapub:
./sync.sh ../datapub-gdx
## Template changes
This extension extends the `templates/blob_storage/snippets/upload_module.html` template:
```
{{ASSETS}}
```
When running `sync.sh`, the `{{ASSETS}}` placeholder will be replaced by the appropiate template tags.
On CKAN>=2.9, `{{ASSETS}}` gets replaced by these two webassets references:
```
{% asset "datapub/datapub-js" %}
{% asset "datapub/datapub-css" %}
```
On CKAN<=2.8, individual fanstatic resources need to be referenced, eg:
```
{% resource 'datapub/css/main.1eb11ae4.chunk.css' %}
{% resource 'datapub/js/runtime-main.c155da57.js' %}
{% resource 'datapub/js/2.2599189b.chunk.js' %}
{% resource 'datapub/js/main.c4752953.chunk.js' %}
```