create-faas-app 8.0.0-beta.36 → 8.0.0-beta.37

package/README.md

@@ -1,81 +1,23 @@
 # create-faas-app
 
-Create a new FaasJS app from a curated starter template.
-
-FaasJS is optimized for database-driven React business applications. `create-faas-app` gives new projects a working starting point for the official path instead of asking every team to assemble React, API, database, testing, and UI conventions from scratch.
-
-This is the key difference from a generic React starter: the default template is shaped around complete business features. A feature is expected to connect UI, typed APIs, validation, PostgreSQL migrations, table types, and tests in one reviewable application slice.
-
-## Quick Start
-
-```bash
-npx create-faas-app --name my-faas-app
-cd my-faas-app
-npm run dev
-```
-
-The default template is `admin`, which demonstrates the curated React + Ant Design + PostgreSQL path.
-
-## Templates
-
-### `admin`
-
-Use `admin` for the golden-path FaasJS starter.
-
-```bash
-npx create-faas-app --name my-admin --template admin
-```
-
-It includes:
-
-- React app structure powered by Vite Plus
-- `@faasjs/ant-design` and Ant Design for business UI
-- `defineApi` endpoints for typed backend APIs
-- a copyable users slice with create, list, detail, update, migration, table types, and API tests
-- `@faasjs/pg` for PostgreSQL access and migrations
-- `@faasjs/pg-dev` for pg-dev-powered tests
-- `.env.example` for local database configuration
-- type declarations for PostgreSQL table inference
+# create-faas-app
 
-This is the best starting point for admin panels, internal tools, SaaS dashboards, and other database-driven business applications.
+[![License: MIT](https://img.shields.io/npm/l/create-faas-app.svg)](https://github.com/faasjs/faasjs/blob/main/packages/create-faas-app/LICENSE)
+[![NPM Version](https://img.shields.io/npm/v/create-faas-app.svg)](https://www.npmjs.com/package/create-faas-app)
 
-### `minimal`
+Curated scaffolder for FaasJS projects. The `admin` template is the default
+React + Ant Design + PostgreSQL starter, and `minimal` provides a smaller
+React starter. After scaffolding, the CLI runs `npm install`, `npm run types`,
+and `npm run test` in the new project.
 
-Use `minimal` when you want a smaller React starter without the database and Ant Design stack.
+## Usage
 
 ```bash
-npx create-faas-app --name my-minimal-app --template minimal
+npx create-faas-app --name faasjs
+npx create-faas-app --name faasjs-admin --template admin
+npx create-faas-app --name faasjs-minimal --template minimal
 ```
 
-It is useful for learning the core FaasJS runtime, building API-only or BFF-style projects, or adding a custom UI/database path intentionally.
-
-## Recommended Path
-
-Start with `admin` unless you have a specific reason not to. It shows how FaasJS expects complete application slices to fit together:
-
-- feature UI calls typed APIs
-- APIs validate inputs at system boundaries
-- APIs use PostgreSQL through the shared database workflow
-- migrations and table types keep data contracts explicit
-- tests cover the API and database behavior
-
-FaasJS allows teams to replace parts of the stack, but the templates, docs, and examples optimize this curated path first.
-
-Use `minimal` only when you intentionally want to step away from that path, such as for an API-only service, a BFF that will be paired with a separate frontend, or an app that needs a custom UI/database stack from day one.
-
-## Auth And Permissions
-
-Authentication and permissions are intentionally not built into FaasJS core because production auth requirements vary by product.
-
-The admin starter includes a small auth plugin demo. Treat it as a plugin pattern that shows how to inject current-user context, protect APIs, and model project-specific permissions. It is not a mandatory framework auth system.
-
-## Next Steps
-
-- Read the FaasJS guide at <https://faasjs.com/guide/>.
-- Review the root README for the project direction and package overview.
-- Explore runnable templates in <https://github.com/faasjs/faasjs/tree/main/templates>.
-- Use the admin starter users slice as the reference for complete UI/API/database/test examples.
-
-## API Docs
+## Functions
 
 - [main](functions/main.md)

package/dist/index.d.ts

@@ -4,6 +4,12 @@ import { Command } from "commander";
 /**
  * Run the `create-faas-app` CLI with a provided argv array.
  *
+ * The array should use the same shape as `process.argv`, including executable
+ * and script slots. Parsing may prompt for a project name, create files, install
+ * dependencies, generate FaasJS action types, and run template tests. Commander
+ * help exits are swallowed and return the shared program; unexpected errors are
+ * printed with `console.error` and also return the program.
+ *
  * @param {string[]} argv - CLI arguments forwarded to Commander.
  * @returns {Promise<Command>} Commander program instance after parsing.
  *

package/dist/index.mjs

@@ -6,7 +6,7 @@ import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 import enquirer from "enquirer";
 //#region package.json
-var version = "8.0.0-beta.35";
+var version = "8.0.0-beta.36";
 //#endregion
 //#region src/action/index.ts
 const prompt = enquirer.prompt;
@@ -56,7 +56,7 @@ function scaffold(rootPath, replacements, templateName) {
 * @param {object} [options] - Optional CLI arguments used to choose the project name and template.
 * @param {string} [options.name] - Target folder name for the generated app.
 * @param {string} [options.template] - Template name such as `admin` or `minimal`.
-* @returns {Promise<void>} Resolves after the project is scaffolded, dependencies are installed, and tests pass.
+* @returns {Promise<void>} Resolves after the project is scaffolded, dependencies are installed, action types are generated, and tests pass.
 * @throws {Error} When the selected template is unknown.
 * @example
 * ```ts
@@ -117,7 +117,10 @@ ${getTemplateNames().join(", ")}`)).option("--name <name>", "Project name").opti
 * [![License: MIT](https://img.shields.io/npm/l/create-faas-app.svg)](https://github.com/faasjs/faasjs/blob/main/packages/create-faas-app/LICENSE)
 * [![NPM Version](https://img.shields.io/npm/v/create-faas-app.svg)](https://www.npmjs.com/package/create-faas-app)
 *
-* Quick way to create a FaasJS project.
+* Curated scaffolder for FaasJS projects. The `admin` template is the default
+* React + Ant Design + PostgreSQL starter, and `minimal` provides a smaller
+* React starter. After scaffolding, the CLI runs `npm install`, `npm run types`,
+* and `npm run test` in the new project.
 *
 * ## Usage
 *
@@ -126,6 +129,8 @@ ${getTemplateNames().join(", ")}`)).option("--name <name>", "Project name").opti
 * npx create-faas-app --name faasjs-admin --template admin
 * npx create-faas-app --name faasjs-minimal --template minimal
 * ```
+*
+* @packageDocumentation
 */
 const commander = new Command();
 commander.storeOptionsAsProperties(false).allowUnknownOption(true).version(version).name("create-faas-app").exitOverride();
@@ -133,6 +138,12 @@ registerCreateFaasApp(commander);
 /**
 * Run the `create-faas-app` CLI with a provided argv array.
 *
+* The array should use the same shape as `process.argv`, including executable
+* and script slots. Parsing may prompt for a project name, create files, install
+* dependencies, generate FaasJS action types, and run template tests. Commander
+* help exits are swallowed and return the shared program; unexpected errors are
+* printed with `console.error` and also return the program.
+*
 * @param {string[]} argv - CLI arguments forwarded to Commander.
 * @returns {Promise<Command>} Commander program instance after parsing.
 *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-faas-app",
-  "version": "8.0.0-beta.36",
+  "version": "8.0.0-beta.37",
   "homepage": "https://faasjs.com/doc/create-faas-app",
   "bugs": {
     "url": "https://github.com/faasjs/faasjs/issues"