create-saasicat-admin 1.0.0-rc.2 → 1.0.0-rc.4

package/README.md

@@ -1,9 +1,21 @@
 # create-saasicat-admin
 
+## What this is
+
 Scaffolding CLI for SuperAdmin frontend projects. Generates a runnable
 Vue 3 + Quasar + Vite project that builds on `@saasicat/ui-vue` and ships
 all standard pages.
 
+## What this is not
+
+Not a dependency. It runs once, writes a Vite + Vue 3 + Quasar project you
+own, and is never installed into it. Nothing it writes is generated again
+later — edit the files freely.
+
+Not the backend. The scaffolded admin talks to a NestJS application that
+already has `@saasicat/nest` wired; without one it starts and shows a login
+screen it cannot get past.
+
 ## Usage
 
 ```bash
@@ -16,7 +28,7 @@ pnpm create saasicat-admin <dir> \
 
 Generates this directory structure:
 
-```
+```text
 <dir>/
 ├── package.json
 ├── vite.config.ts
@@ -59,3 +71,8 @@ pnpm dev   # http://localhost:9100/admin/login
 3. Adapt the Vite proxy in `vite.config.ts` to your backend port.
 
 Everything else comes from `@saasicat/ui-vue`.
+
+## Next
+
+- [Build the admin frontend](../../docs/guides/build-the-admin-frontend.md) — what the scaffolder wrote, explained
+- [Design guide](../../docs/explanation/design-guide.md) — before you write a page of your own

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-saasicat-admin",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.4",
   "description": "Scaffolding CLI for SuperAdmin frontend projects (Vue 3 + Quasar + Vite). Generates a minimal working admin app built on @saasicat/ui-vue. Usage: `pnpm create saasicat-admin <dir>`.",
   "type": "module",
   "bin": {

package/templates/README.md.tpl

@@ -21,4 +21,5 @@ serve `__API_BASE__/manifest`.
 - Add your own project pages in `src/router/routes.ts` (with
   `createProjectPageHostRoute()` as a catch-all).
 - Register KPI cards, tenant actions and project pages in your backend
-  manifest (see `docs/handbook.md` §6.6 in the saasicat repo).
+  manifest (see `docs/guides/wire-the-backend.md`, "Manifest Contributions",
+  in the saasicat repo).

package/templates/src/main.ts.tpl

@@ -37,7 +37,7 @@ const handle = createSuperAdminApp({
     extensions: {},
     // Starting UI language — the shell's header switcher lets the user change
     // it from there and remembers the pick. `overrides` replaces individual
-    // strings (handbook §8.7).
+    // strings (docs/guides/build-the-admin-frontend.md, "UI Language").
     i18n: { locale: 'en' },
 });
 

package/templates/src/services/platform-loaders.ts.tpl

@@ -1,6 +1,6 @@
 // BootLoader + ManifestLoader built from the same endpoint constant that
 // `main.ts` passes to `createSuperAdminApp()` — endpoints live in exactly
-// one place (handbook §8.1).
+// one place (docs/guides/build-the-admin-frontend.md, "Platform Loaders").
 
 import { createPlatformLoaders, type SuperAdminEndpoints } from '@saasicat/ui-vue';
 import { platformHttp } from './http';

package/templates/src/stores/manifest.ts.tpl

@@ -1,5 +1,6 @@
 // Manifest Pinia store — the router guard in `main.ts` awaits
-// `ensureLoaded()` before rendering admin routes (handbook §8.2).
+// `ensureLoaded()` before rendering admin routes
+// (docs/guides/build-the-admin-frontend.md, "Manifest Store").
 
 import { createManifestStore } from '@saasicat/ui-vue';
 import { loaders } from '../services/platform-loaders';