create-model-city-app
v1.0.7
Published
Scaffold a Model City front-end city project: a Next.js app consuming the @modelcity/* platform packages, with build-time module selection and per-city overrides.
Readme
create-model-city-app
Scaffolds a Model City city front-end — the npm analogue of the back-end's
Maven archetypes. The generated project is a Next.js app that consumes the
@modelcity/* platform packages from the npm registry, with build-time module
selection (modelcity gen) and a per-city overrides/ extension mechanism.
Usage
npm create model-city-app@latest my-cityOptions:
| Option | Effect |
| --- | --- |
| --name=<name> | npm package name (default: the directory name) |
| --modules=<list> | comma-separated feature modules (leisure, engagement, mobility), all or none; skips the prompt |
| --yes | accept all defaults, no prompts (CI-friendly) |
What you get
package.jsonwith the platform packages pinned to this archetype's release-train version and the exact peer stack (Next, React, Auth0, Stripe, MapLibre) the platform is built against.modules.config.mjs— the city's declaration of contracted modules.- Project wiring derived from the platform's reference app at publish time
(via
sync-template.mjs):next.config.mjs,postcss.config.mjs(Tailwind v4),eslint.config.mjs,jsconfig.jsonwith the overrides fallback,public/and.gitignore. - Static wiring maintained in the archetype itself (not derived from the
reference app):
Dockerfile,.dockerignoreand.env.example. - An empty
overrides/directory documenting the extension mechanism.
Links
- Model City platform repository — architecture, the rest of the release train and the platform packages this archetype wires in.
Author
Created and maintained by Jesús Pérez Melero, author of the Model City platform.
License
MIT — see LICENSE.
