Portaljs new portal
π AI-native framework for building data portals. Scaffold a full portal from a brief and load datasets in minutes with agentic skills β any backend (CKAN, GitHub, Frictionless).
npx -y skills add datopian/portaljs --skill portaljs-new-portalAssembled 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
Scaffold a new PortalJS data portal from a brief. Copies the canonical template from examples/portaljs-catalog and substitutes project tokens. Use when starting a brand-new data portal project from scratch.
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.8 KB, as published. Nobody here has run it
PortalJS β New Portal
Overview
Scaffold a production-ready PortalJS data portal from a brief. The skill is
interactive: if the brief is thin it interviews the user in three short rounds
(mapped to the template's three surfaces β Home, Catalog, Showcase), echoes a brief
back for confirmation, then copies examples/portaljs-catalog (locally or via a
remote tiged fetch), substitutes placeholder tokens, sets the namespace mode, seeds
any datasets named in the interview, installs dependencies, and verifies the scaffold
with a type check.
Prerequisites
- Node.js >=22 and npm available on
PATH. - Network access, unless a current local checkout of the portaljs repo is available (the resolver defaults to a remote fetch of the template).
- A destination directory name that does not already contain files (or user consent to overwrite one that does).
Instructions
The canonical, full step-by-step workflow is
.claude/commands/portaljs-new-portal.md β
the single source of truth. Read and follow it when executing. Summary:
- Interview the user in up to three rounds β Home/basics, Catalog & discovery
(datasets, namespace mode
themevsowner), Showcase/views β skipping any round already answered by the input brief. Accept "use defaults" at any point. - Confirm a short brief (name, slug, description, namespace, datasets, views) before building.
- Resolve the template source: prefer a remote
tigedfetch ofexamples/portaljs-catalogatmain(orPORTALJS_TEMPLATE_REF); use a local checkout only when it is current (haspages/[owner]/[slug].tsx) and the destination is outside that repo. - Materialize the template into
./PROJECT_SLUG, asking first if the destination already exists and is non-empty. - Substitute
__PROJECT_NAME__,__PROJECT_SLUG__,__DESCRIPTION__tokens across all files withperl -pi, escaping/,\, and&in the values. - Set
NAMESPACE_TYPE('theme'or'owner') inlib/datasets.tsper the interview. - Seed datasets captured in Round 2 (via
/portaljs-add-datasetor by hand), or cleardatasets.jsonto[]if none were named. - Run
npm installinside the scaffolded portal. - Verify with
npx tsc --noEmit(nevernext buildhere β it would corrupt a running dev server's.next/directory). - Report the scaffolded routes, namespace mode, and next steps.
Output
- Created: a new directory
./PROJECT_SLUG/containing the fullexamples/portaljs-catalogtemplate with tokens substituted. - Modified:
lib/datasets.ts(NAMESPACE_TYPE);datasets.json(seeded datasets or cleared to[]). - Verified:
npx tsc --noEmitpasses inside the scaffolded portal. - Result: a runnable portal at
./PROJECT_SLUGwith Home (/), Catalog (/search), and Showcase (/@<namespace>/<slug>) surfaces wired up.
Error Handling
| Symptom | Cause | Fix |
|---|---|---|
DIR_EXISTS | ./PROJECT_SLUG already exists and is non-empty | Ask the user for a different name or consent to remove it; then proceed. |
| Remote fetch fails | Bad PORTALJS_TEMPLATE_REF, network outage, or tiged unavailable | Tell the user plainly and ask to retry, use a different ref, or check network. |
Stale local scaffold (pages/datasets/[slug].tsx) | Old local clone missing pages/[owner]/[slug].tsx | Resolver already falls back to remote in this case β do not force local mode. |
npm install fails | Node <22 or no network | Report the error and ask the user to check Node version and connectivity. |
tsc --noEmit fails | Token substitution or manifest error | Print the log and fix before reporting success β never report success with a failing type check. |
Examples
Example 1 β Full brief up front
/portaljs-new-portal Auckland Open Data Portal β datasets published by several council
departments (multiple publishers). Start with ./data/parks.csv and ./data/budget.csv.
Infers name + description, picks NAMESPACE_TYPE = 'owner', asks for namespace
values (e.g. parks-dept, finance), confirms the brief, scaffolds the template, and
seeds both datasets at /@parks-dept/parks and /@finance/budget.
Example 2 β No arguments, full interview
/portaljs-new-portal
Runs all three interview rounds from scratch, accepting "use defaults" for any round, then confirms the brief before scaffolding.
Example 3 β Single-publisher portal with no datasets yet
/portaljs-new-portal Reference Data Hub β a single-team reference catalog, no data yet.
Picks NAMESPACE_TYPE = 'theme' with namespace reference, clears datasets.json to
[], and reports /portaljs-add-dataset as the next step.
Resources
- Full workflow:
.claude/commands/portaljs-new-portal.md - Template and token reference:
references/reference.md - Related skills:
portaljs-add-dataset,portaljs-add-chart,portaljs-add-map,portaljs-connect-ckan - PortalJS documentation: https://portaljs.org