portaljs-new-portal
Skill2.4k starsChanged 12 days agoMITView on GitHub
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.
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 23
interactive: if the brief is thin it interviews the user in three short rounds (mapped to the template's three surfaces — Home, Catalog, …
- Very specific: line 66
Run npm install inside the scaffolded portal.
- Very specific: line 67
Verify with npm run i18n:check and npx tsc --noEmit (never next build here — it would corrupt a running dev server's .next/ directory).
≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
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 and the
UI language, 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 (incl. the UI language,
default English), 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, language, 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. - Set the UI language (skip for English): translate
locales/en.jsonintolocales/<code>.json(every key,{placeholders}verbatim, the plural forms the language uses,_intlBCP 47 tag such asit-IT), register it inlib/i18n.ts, setDEFAULT_LOCALEinnext.config.js, and runnpm run i18n:check. - 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
npm run i18n:checkandnpx tsc --noEmit(nevernext buildhere — it would corrupt a running dev server's.next/directory). - Report the scaffolded routes, namespace mode, language, 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[]); for a non-English portal,locales/<code>.json(created),lib/i18n.ts(registered) andnext.config.js(DEFAULT_LOCALE). - Verified:
npm run i18n:checkandnpx tsc --noEmitpass 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-portalRuns 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
Trending
Steady: 0 new projects took it in the last 4 weeks, none the 4 weeks before.thin data
Who's talking about datopian/portaljs
- A Hacker News story“Show HN: PortalJS – AI-native, open-source framework for data portals”Hacker News · Jul 15, 2026 · 10 points
- fuma-nama/fumadocs“[feat] support obsidian style wikilinks, backlinks, embeds, graph view”GitHub · Mar 17, 2025 · 1 reactions
- sudosubin/agents.nix“claude-code-marketplaces.github.datopian.portaljs: init at 0-unstable-2026-10-27”GitHub · Oct 28, 2026
- sudosubin/agents.nix“agent-skills.github.datopian.portaljs: 0-unstable-2026-10-15 → 0-unstable-2026-10-20”GitHub · Oct 20, 2026
- sudosubin/agents.nix“agent-skills.github.datopian.portaljs: 0-unstable-2026-08-20 → 0-unstable-2026-10-15”GitHub · Oct 20, 2026
The biggest 5 of 38 mentions linking to the repository that our crawl found. Each line is their own headline.
See all 38
Talked about on GitHub and Hacker News (38 times).
On GitHub · 37
- Mar 17, 2025[feat] support obsidian style wikilinks, backlinks, embeds, graph view — fuma-nama/fumadocs1 reaction · 1 comment
- Oct 28, 2026claude-code-marketplaces.github.datopian.portaljs: init at 0-unstable-2026-10-27 — sudosubin/agents.nix0 reactions
- Oct 20, 2026agent-skills.github.datopian.portaljs: 0-unstable-2026-10-15 → 0-unstable-2026-10-20 — sudosubin/agents.nix0 reactions
- Oct 20, 2026agent-skills.github.datopian.portaljs: 0-unstable-2026-08-20 → 0-unstable-2026-10-15 — sudosubin/agents.nix0 reactions
- Oct 3, 2026agent-skills.github.datopian.portaljs: 1.4.0-unstable-2026-08-20 → 0-unstable-2026-08-20 — sudosubin/agents.nix0 reactions
32 more on GitHub
- Sep 30, 2026docs: fix typos and a stale CKAN example link — olitreadwell/portaljs0 reactions
- Sep 26, 2026agent-skills.github.datopian.portaljs: init at 1.4.0-unstable-2026-08-20 — sudosubin/agents.nix0 reactions
- Sep 26, 2026[Candidate] datopian/portaljs/skills/portaljs-add-dataset - portaljs-add-dataset — ProSkillsMD/proskills0 reactions · 2 comments
- Sep 26, 2026[Candidate] datopian/portaljs/skills/portaljs-add-chart - portaljs-add-chart — ProSkillsMD/proskills0 reactions · 2 comments
- Sep 26, 2026[Candidate] datopian/portaljs/skills/arcgis-to-portaljs - arcgis-to-portaljs — ProSkillsMD/proskills0 reactions · 1 comment
- Aug 12, 2026fix(ckan): make Pagination page buttons readable by screen readers — olitreadwell/portaljs0 reactions
- Aug 12, 2026fix(ckan-api-client-js): restore validation error fallback message — olitreadwell/portaljs0 reactions
- Aug 12, 2026fix(create-portaljs): make the scaffold template source repo-aware — olitreadwell/portaljs0 reactions
- Jul 8, 2026Add charts to the homepage — datopian/portaljs-research0 reactions · 2 comments
- Jul 7, 2026Add PortalJS plugin (datopian/portaljs) — tmcpa/claudedirectory0 reactions · 1 comment
- Jun 25, 2026Improve ui/ux — datopian/portaljs-research0 reactions · 2 comments
- Mar 24, 2026content: migrate two legacy Flowershow tutorials from portaljs.com — flowershow/flowershow0 reactions · 2 comments
- Dec 12, 2025Consolidate datahubio repos into datasets org — datasets/collective0 reactions
- Nov 21, 2025Added scope organization param into MCP URL to allow specific organizations — datopian/portaljs-mcp-server0 reactions · 2 comments
- Oct 29, 2025[BUG Fix] Pagination and table — datopian/portaljs-frontend-starter0 reactions · 2 comments
- Oct 19, 2025[BUG FIX] Frontend table preview — datopian/portaljs-frontend-starter0 reactions · 2 comments
- Oct 19, 2025[Bug Fix] Table Preview Frontend issues — datopian/portal-lcc0 reactions · 2 comments
- Oct 9, 2025preview data table tool — datopian/portaljs-mcp-server0 reactions · 1 comment
- Oct 7, 2025[IMPLEMENTING] Auth for portalJS key — datopian/portaljs-mcp-server0 reactions · 2 comments
- Sep 18, 2025Dataverse Harvester Implementation — datopian/harvesterjs0 reactions · 1 comment
- Jul 6, 2025Move all flowershow stuff from portaljs and add redirects — flowershow/flowershow0 reactions · 1 comment
- May 9, 2025Enable Iframe previews — datopian/portaljs-frontend-starter0 reactions · 2 comments
- Dec 28, 2023Transfer here "create a simple catalog of anything using markdown" — flowershow/wayofmarkdown0 reactions · 8 comments
- Dec 14, 2023Migrate content from portaljs.org/guide to this site — flowershow/wayofmarkdown0 reactions · 6 comments
- Oct 23, 2023[DO-NOT_MERGE] Improvement suggestions — flowershow/flowershow0 reactions · 1 comment
- Sep 20, 2023When I have a remote content e.g. https://github.com/datasets/awesome-data I want to load and render that (statically) so that i can author content in another repo but render it here — Valecia2023/caring.net0 reactions
- Jun 12, 2023Setup auto-publishing to npm — flowershow/markdowndb0 reactions
- May 26, 2023Turn this repo into core template and move core lib to portaljs repo — flowershow/flowershow0 reactions · 2 comments
- May 17, 202317 consolidate gitignore and expand its entries — hackforla/accessthedata-ckan0 reactions
- May 16, 2023[EPIC] Editor guide: how to contribute content and datasets — flowershow/wayofmarkdown0 reactions · 2 comments
- Apr 28, 2023[epic] MarkdownDB site (landing page) and "launch" — flowershow/markdowndb0 reactions · 6 comments
- Oct 30, 2022Analytics other than Google Analytics (and switch to pliny model) — flowershow/flowershow0 reactions · 2 comments
On Hacker News · 1
- Jul 15, 2026Show HN: PortalJS – AI-native, open-source framework for data portals10 points · 1 comment
In this repository16 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- site/CLAUDE.mdCLAUDE.md
- arcgis-to-portaljsSkill
- portaljs-add-chartSkill
- portaljs-add-datasetSkill
- portaljs-add-dcatSkill
- portaljs-add-geoSkill
- portaljs-add-mapSkill
- portaljs-add-resourceSkill
- portaljs-architectSkill
- portaljs-check-data-qualitySkill
- portaljs-connect-ckanSkill
- portaljs-define-schemaSkill
- portaljs-deploySkill
- portaljs-migrateSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

