Portaljs connect ckan
425 plugins, 2,810 skills, 200 agents for Claude Code. Open-source marketplace at tonsofskills.com with the ccpi CLI package manager.
npx -y skills add jeremylongshore/claude-code-plugins-plus-skills --skill portaljs-connect-ckanAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
What its author says it does
Copied from the file, not written here
Wire a scaffolded PortalJS portal to a CKAN backend over its API. Generates a tiny server-side fetch client (no runtime dependency) and feeds the /search catalog and /@namespace/slug showcases from CKAN instead of datasets.json. Use when connecting an existing portal to a live CKAN instance instead of a static manifest.
The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.
SKILL.md
5.9 KB, as published. Nobody here has run it
PortalJS — Connect CKAN
Overview
Connect an existing portaljs-catalog portal to a live CKAN backend for the "decoupled /
any backend" path. The portal stops reading the static datasets.json manifest (and files
in /public/data/) and instead feeds its two data surfaces — the /search catalog and
the /@namespace/slug showcases — straight from a CKAN instance's REST API
(package_search / package_show) through a generated fetch client. Output is plain,
editable Next.js code with no runtime dependency — never @portaljs/ckan, whose bundle
wires React UI components to React 18 internals and crashes at import under the template's
React 19. Pages fetch CKAN server-side in getStaticProps/getStaticPaths, so the catalog
is pre-rendered at build time and the site can still be statically deployed. Run this right
after portaljs-new-portal to swap a freshly scaffolded portal's sample data over to CKAN.
Prerequisites
- A scaffolded PortalJS portal (see
portaljs-new-portal) withpackage.json,pages/,datasets.json,pages/search.tsx, andpages/[owner]/[slug].tsxpresent. - A CKAN base URL that is publicly reachable, e.g.
https://demo.dev.datopian.com. - Node 18+ and npm available in the portal directory (no new packages are installed).
Instructions
The canonical, full step-by-step workflow is
.claude/commands/portaljs-connect-ckan.md —
the single source of truth. Read and follow it when executing. Summary:
- Gather input from
$ARGUMENTS— CKAN base URL (required), org filter (optional), group filter (optional), portal directory (default.). If the URL is missing, interview the user; never dead-end with a missing-input error. - Validate the target directory is a
portaljs-catalogportal; if not, suggestportaljs-new-portalinstead of failing silently. - Verify the CKAN backend is reachable via
package_search?rows=1, and validate each org filter viaorganization_show; on failure, explain and re-prompt rather than dead-ending. - Generate
lib/ckan.ts— a self-contained server-side fetch client wrappingpackage_searchandpackage_show, withDMS,ORG_FILTER,GROUP_FILTER, andMAX_DATASETSas editable constants. - Rewire
pages/search.tsxto list datasets frompackage_search, linking each to/@namespace/slugviadatasetHref; leavepages/index.tsxuntouched. - Overwrite
pages/[owner]/[slug].tsxto pre-render one page per dataset viagetStaticPathsand fetch details withpackage_show, previewing tabular resources through the existingTablecomponent. - Verify the build with
npx next build; fix any error before reporting success. - Report what changed: client, catalog, showcase, filters, and static page count.
Output
- Created:
lib/ckan.ts(fetch wrapper client — no dependency added topackage.json). - Modified:
pages/search.tsx(catalog readspackage_search);pages/[owner]/[slug].tsx(showcase readspackage_show, overwritten to drop thedatasets.jsonsource). - Unchanged:
pages/index.tsx(still the static search-first landing page). - Verified:
npx next buildsucceeds and prints the static page count. - Result:
/searchand/@namespace/slugare served from the CKAN backend; theDMSenv var can override the base URL at deploy time without editing code.
Error Handling
| Symptom | Cause | Fix |
|---|---|---|
| Missing CKAN URL | User invoked the skill with no $ARGUMENTS | Ask for the base URL (and optional org/group filter); never error out. |
package_search request fails or times out | URL isn't a reachable CKAN root | Tell the user, ask them to confirm the URL, and retry. |
| Org filter not found | organization_show returns success: false | List valid orgs from organization_list and ask which one was meant. |
| Catalog renders empty after connecting | Wrong org/group filter name in lib/ckan.ts | Clear or correct the filter constants and rebuild. |
next build fails | Typo in substituted CKAN_URL or bad TypeScript edit | Print the log, fix the first error, and re-run before reporting success. |
<Table> fails to load a resource | CKAN resource host blocks CORS | Note that the Download link still works; prefer datastore-backed resources. |
Examples
Example 1 — Public CKAN demo, no filters
/portaljs-connect-ckan url=https://demo.dev.datopian.com
Example 2 — Restrict the catalog to one organization
/portaljs-connect-ckan url=https://demo.dev.datopian.com org=my-org
Example 3 — Filter by group and target a specific portal directory
/portaljs-connect-ckan url=https://data.example.gov group=education dir=./my-portal
Resources
- Full workflow:
.claude/commands/portaljs-connect-ckan.md - Client, filters, and troubleshooting reference:
references/reference.md - Related skills:
portaljs-new-portal,portaljs-add-dataset,portaljs-deploy - CKAN Action API documentation: https://docs.ckan.org/en/latest/api/