create-bcp-app 0.2.2 → 0.2.4

package/README.md

@@ -19,6 +19,7 @@ Generated npm scripts use `bcp` because npm places `node_modules/.bin` on the sc
   "scripts": {
     "dev": "bcp dev",
     "build": "bcp build",
+    "package": "bcp package",
     "start": "bcp start",
     "routes": "bcp routes",
     "generate": "bcp generate",
@@ -27,6 +28,16 @@ Generated npm scripts use `bcp` because npm places `node_modules/.bin` on the sc
 }
 ```
 
+When Tailwind CSS is selected, the generated packaging script preserves the production CSS step:
+
+```json
+{
+  "scripts": {
+    "package": "npm run css:build:prod && bcp package"
+  }
+}
+```
+
 For direct PowerShell usage, prefer the collision-free local alias:
 
 ```powershell
@@ -37,6 +48,7 @@ npm exec -- bcp-framework generate page dashboard/users
 npm exec -- bcp-framework routes
 npm exec -- bcp-framework dev
 npm exec -- bcp-framework build
+npm exec -- bcp-framework package
 ```
 
 Microsoft SQL Server can install another Windows executable named `bcp.exe`, so `bcp-framework` is the recommended interactive Windows command name.
@@ -65,7 +77,7 @@ Select storage provider:
 
 Equivalent non-interactive flags are available for CI/scaffolding automation.
 
-## Generated project metadata — 0.1.29
+## Generated project metadata
 
 New projects include:
 
@@ -80,10 +92,10 @@ Example:
   "schemaVersion": 1,
   "framework": "bcp",
   "projectName": "my-app",
-  "frameworkPackage": "npm:@chidchanun/bcp@0.1.29",
+  "frameworkPackage": "npm:@chidchanun/bcp@0.2.4",
   "createdWith": {
     "package": "create-bcp-app",
-    "version": "0.1.29"
+    "version": "0.2.4"
   },
   "packageManager": "npm",
   "presets": {
@@ -95,22 +107,10 @@ Example:
 }
 ```
 
-This manifest records scaffold identity only. It is intended for:
-
-- `bcp doctor`,
-- `bcp inspect`,
-- upgrade/migration tooling,
-- project-aware documentation,
-- `bcp-docs-web` examples/tooling.
-
-It must not contain secrets. Never put database passwords, AWS/R2 credentials, JWT/session secrets or tokens in `bcp.project.json`.
+This manifest records scaffold identity only. It is intended for framework diagnostics, update/migration tooling and project-aware documentation. It must not contain secrets.
 
 The file should normally be committed to source control.
 
-Existing projects created before `0.1.29` remain valid without it.
-
-Read more: `docs/project-metadata.md` in the BCP Framework repository.
-
 ## Generated application defaults
 
 Generated applications include the project-root `@/` alias and TypeScript settings compatible with the BCP bundler.
@@ -135,12 +135,12 @@ npm exec -- bcp-framework update --check
 
 When Tailwind is enabled, the project includes:
 
-- `tailwindcss`,
-- `@tailwindcss/cli`,
-- `concurrently`,
-- `app/globals.css`,
-- `/bcp.css` stylesheet setup,
-- starter utility classes.
+- `tailwindcss`
+- `@tailwindcss/cli`
+- `concurrently`
+- `app/globals.css`
+- `/bcp.css` stylesheet setup
+- starter utility classes
 
 Generated commands include:
 
@@ -150,7 +150,7 @@ npm run css:watch
 npm run css:build:prod
 ```
 
-`npm run build` creates the production stylesheet before the BCP production build.
+`npm run build` and `npm run package` create the production stylesheet before the BCP production build/package flow.
 
 ## Database presets
 
@@ -162,13 +162,7 @@ The database choice adds starter configuration and the matching driver:
 - MongoDB: `mongodb`
 - None: no database dependency
 
-Server-only database helpers begin with:
-
-```ts
-import "bcp/server-only";
-```
-
-For MySQL, the generated helper exposes the BCP database primitives through `bcp/database`.
+For **MySQL**, **PostgreSQL** and **SQLite**, generated `lib/database.ts` exposes the framework database primitives through `bcp/database`. Provider connections are managed behind Database Platform v2 instead of being created directly in generated application code.
 
 Generated MySQL environment variables:
 
@@ -180,33 +174,38 @@ DB_PASSWORD=
 DB_NAME=bcp_app
 ```
 
-The generator intentionally does not force an ORM.
+Generated PostgreSQL environment variable:
 
-## Storage providers
+```dotenv
+DATABASE_URL=postgresql://postgres:password@localhost:5432/bcp_app
+```
 
-Selecting a storage provider creates:
+Generated SQLite environment variable:
 
-```text
-lib/storage.ts
+```dotenv
+DATABASE_URL=./data/bcp.sqlite
 ```
 
-and adds provider-specific environment settings.
+`bcp/database` infers PostgreSQL from `postgres://` or `postgresql://` connection URLs. SQLite is inferred from `:memory:`, `sqlite:` / `file:` locations and common `.sqlite`, `.sqlite3` or `.db` file paths. Applications may also configure `DB_DRIVER` explicitly.
 
-### Local Server
+Placeholder syntax follows the selected provider:
 
-```bash
-npx create-bcp-app my-app --storage local
+```text
+MySQL       ?
+SQLite      ?
+PostgreSQL  $1, $2, ...
 ```
 
-Generated structure:
+The generator intentionally does not force an ORM.
 
-```text
-lib/
-└─ storage.ts
+## Storage providers
 
-storage/
-├─ .gitkeep
-└─ README.md
+Selecting a storage provider creates `lib/storage.ts` and adds provider-specific environment settings.
+
+### Local Server
+
+```bash
+npx create-bcp-app my-app --storage local
 ```
 
 Environment:
@@ -215,14 +214,6 @@ Environment:
 STORAGE_LOCAL_DIRECTORY=./storage
 ```
 
-`.gitignore` keeps the visible scaffold while ignoring runtime objects:
-
-```gitignore
-storage/*
-!storage/.gitkeep
-!storage/README.md
-```
-
 The generated helper uses `createLocalStorage()`.
 
 ### Amazon S3
@@ -260,17 +251,8 @@ R2_SECRET_ACCESS_KEY=
 R2_PREFIX=
 ```
 
-The helper configures the S3-compatible adapter with:
-
-```text
-region: auto
-endpoint: https://<account-id>.r2.cloudflarestorage.com
-```
-
 Storage credentials are server-only. Do not expose them through `BCP_PUBLIC_*` variables.
 
-The storage preset is only an initial scaffold; application routes/services can later use another BCP adapter while keeping generic storage APIs.
-
 ## JWT Cookie authentication
 
 Selecting `JWT Cookie` creates:
@@ -293,11 +275,45 @@ BCP_SESSION_SECRET=
 
 Set this to a cryptographically random secret of at least 32 bytes before real authentication use.
 
-The generated `authenticateCredentials(email, password)` returns `null` until the application connects it to its own user store and password-hash verification. This prevents a fresh project from trusting unverified browser identity data.
+The generated `authenticateCredentials(email, password)` returns `null` until the application connects it to its own user store and password-hash verification.
 
-## Project generators after creation
+## Application Packaging — 0.2.4+
+
+Generated projects include:
 
-BCP `0.1.29+` can scaffold additional framework files after the project has been created:
+```bash
+npm run package
+```
+
+This runs the BCP `standalone-node` application packaging flow and writes:
+
+```text
+.bcp-framework/package/
+├─ client/
+├─ server/
+├─ public/                 # when present
+├─ package.json
+├─ package-lock.json       # when a safe production lock can be derived
+├─ bcp.package.json
+├─ bcp.deployment.json
+├─ bcp.env.json
+├─ Dockerfile
+└─ README.md
+```
+
+The deployment package excludes application `devDependencies` and project `.env` values. Supply real secrets through the deployment environment.
+
+For a package with a generated production lockfile:
+
+```bash
+cd .bcp-framework/package
+npm ci --omit=dev
+npm start
+```
+
+If the package manifest reports that no lockfile was included, use the install command recorded in `bcp.package.json`.
+
+## Project generators after creation
 
 ```bash
 npm run generate -- page dashboard/users
@@ -341,6 +357,8 @@ Examples:
 
 ```bash
 npx create-bcp-app my-app --tailwind --database mysql --auth jwt-cookie --storage local
+npx create-bcp-app my-app --database postgresql
+npx create-bcp-app my-app --database sqlite
 npx create-bcp-app my-app --storage amazon-s3
 npx create-bcp-app my-app --storage cloudflare-r2
 npx create-bcp-app my-app --no-tailwind --database mongodb
@@ -350,5 +368,5 @@ npx create-bcp-app my-app --yes
 The `--bcp` option is mainly for prerelease/local package verification:
 
 ```bash
-npx create-bcp-app my-app --bcp file:../chidchanun-bcp-0.1.29.tgz
+npx create-bcp-app my-app --bcp file:../chidchanun-bcp-0.2.4.tgz
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-bcp-app",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "Create a new BCP Framework application.",
   "type": "module",
   "license": "MIT",

package/src/index.mjs

@@ -98,6 +98,8 @@ export async function createBcpApp(
                 "bcp dev",
             build:
                 "bcp build",
+            package:
+                "bcp package",
             start:
                 "bcp start",
             routes:
@@ -147,6 +149,13 @@ export async function createBcpApp(
             storage,
         });
 
+    if (
+        selectedOptions.tailwind
+    ) {
+        packageJson.scripts.package =
+            "npm run css:build:prod && bcp package";
+    }
+
     configureFrameworkDatabaseEntry(
         targetDirectory,
         selectedOptions.database
@@ -388,7 +397,9 @@ function configureFrameworkDatabaseEntry(
     database
 ) {
     if (
-        database !== "mysql"
+        database !== "mysql" &&
+        database !== "postgresql" &&
+        database !== "sqlite"
     ) {
         return;
     }

package/template/README.md

@@ -20,11 +20,12 @@ npm run routes
 npm run generate -- page dashboard/users
 npm run typecheck
 npm run build
+npm run package
 npm start
 npm run update
 ```
 
-The generated scripts call commands such as `bcp dev`, `bcp generate`, `bcp build` and `bcp start`. npm automatically adds the project's `node_modules/.bin` directory to `PATH` while an npm script is running.
+The generated scripts call commands such as `bcp dev`, `bcp generate`, `bcp build`, `bcp package` and `bcp start`. npm automatically adds the project's `node_modules/.bin` directory to `PATH` while an npm script is running.
 
 ## Project metadata
 
@@ -40,7 +41,7 @@ Commit this file with the project. Do not put passwords, access keys, session se
 
 ## Generate framework files
 
-BCP `0.1.29+` can generate common project files:
+BCP can generate common project files:
 
 ```bash
 npm run generate -- page dashboard/users
@@ -80,6 +81,7 @@ npm exec -- bcp-framework generate page dashboard/users
 npm exec -- bcp-framework routes
 npm exec -- bcp-framework dev
 npm exec -- bcp-framework build
+npm exec -- bcp-framework package
 ```
 
 You can also execute the Windows command shim explicitly:
@@ -115,9 +117,9 @@ npm exec -- bcp-framework inspect --json
 
 Doctor checks common project/runtime problems while Inspect shows the resolved configuration, routes, dependencies and project metadata BCP sees.
 
-## Production
+## Production build
 
-Create the standalone production build:
+Create the raw standalone production build:
 
 ```bash
 npm run build
@@ -130,3 +132,31 @@ npm start
 ```
 
 The production build is written to `.bcp-framework/build` and runs as a standalone Node.js server.
+
+## Deployment package — BCP 0.2.4+
+
+Create a fresh production build and deployment-oriented package:
+
+```bash
+npm run package
+```
+
+The output is written to:
+
+```text
+.bcp-framework/package/
+```
+
+It contains the standalone client/server output, a production-only dependency manifest, deployment/environment metadata, file integrity hashes and a starter Dockerfile.
+
+BCP intentionally excludes project `.env` files and application `devDependencies` from the deployment package. Provide secrets through your deployment environment.
+
+For a package with a generated production lockfile:
+
+```bash
+cd .bcp-framework/package
+npm ci --omit=dev
+npm start
+```
+
+If `bcp.package.json` reports that no lockfile was included, use the install command recorded in that manifest instead.