Creating a new application

Initializing a new application

New applications are created using the repository's init script from the repo root. It scaffolds an app from the template/ folder into apps/<app-name> and can also create or link an Appframe article.

Run from the repository root:

pnpm init-app namespace-app-name
  • Name: Should match the Appframe article ID, generally lowercase with hyphens, prefixed by namespace (e.g. namespace-app-name).

  • Prompts: You will be asked which website to target and whether to create a new Appframe article or use an existing one. If creating, you'll be prompted for title and description.

Running the new app

Start the dev server for the new app using pnpm workspaces:

pnpm --filter namespace-app-name start

Or directly from the app folder:

cd apps/namespace-app-name
pnpm start

The app runs at http://localhost:5173. Make edits in apps/namespace-app-name/src/ and the page will live‑reload. If dependencies need updates, run your app's check script (when present) to review and update them interactively.

Last updated

Was this helpful?