create-vexcms 0.0.20 → 0.1.0-alpha.11

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,161 +1,194 @@
 # create-vexcms
 
-Scaffolding CLI for [VEX CMS](https://github.com/ianyimi/vex) projects. Creates a complete Next.js application with Convex backend, Better Auth authentication, and an admin panel — ready to run.
+> [!WARNING]
+> `create-vexcms` is pre-release software, published only under the `alpha` npm
+> dist-tag (`0.1.0-alpha.x`) — the `latest` tag on npm still points at an old,
+> unrelated `0.0.20` line, so always scaffold with an explicit tag:
+> `pnpm create vexcms@alpha`. Use it for experiments and evaluation only; the
+> projects it scaffolds should not carry production traffic or real user data.
+> Breaking changes land between alpha releases without deprecation cycles, and
+> there is no migration path between alphas. See the
+> [roadmap](https://docs.vexcms.dev) for what is and is not shipped.
+
+Scaffolding CLI for [VexCMS](https://github.com/ianyimi/vex) projects. Creates a complete
+Next.js application with a Convex backend, Better Auth authentication, and a self-hosted admin
+panel — ready to run.
 
 ## Usage
 
 ```bash
-pnpm create vexcms@latest
+pnpm create vexcms@alpha
 ```
 
 Or with a project name:
 
 ```bash
-pnpm create vexcms@latest my-project
+pnpm create vexcms@alpha my-project
 ```
 
-Supports relative paths:
+Supports relative paths, including scaffolding straight into a monorepo app directory:
 
 ```bash
-pnpm create vexcms@latest apps/website
+pnpm create vexcms@alpha apps/website
 ```
 
 ## Flags
 
 | Flag | Description |
 |------|-------------|
-| `--bare` | Skip the marketing site template. Scaffolds an empty VEX CMS project with no collections. |
-| `--orgs` | Enable multi-tenant organizations (adds Better Auth organizations plugin). |
+| `--bare` | Skip the marketing-site overlay. Scaffolds `base-nextjs` alone — auth, admin panel, media, and no starter collections. |
+| `--orgs` | Enable multi-tenant organizations (adds the Better Auth organizations plugin). |
+| `--monorepo` | Scaffold into `apps/<name>` under the nearest ancestor `pnpm-workspace.yaml` instead of a standalone project. Rewrites `@vexcms/*` dependencies to `workspace:*` and any dependency present in the host workspace's catalog to `catalog:`; every other dependency stays a literal version. Skips `git init` and dependency install — the root workspace owns both. |
+| `--yes` | Accept every interactive prompt's default (bare: no, orgs: no, port: `3010`, no OAuth providers, git init: yes, install: no) — no prompts at all. |
 
 ```bash
-# Empty project with no pre-built collections
-pnpm create vexcms@latest my-app --bare
+# Empty project, no pre-built collections
+pnpm create vexcms@alpha my-app --bare
 
-# Project with organizations support
-pnpm create vexcms@latest my-app --orgs
-```
+# Project with multi-tenant organizations
+pnpm create vexcms@alpha my-app --orgs
 
-## Interactive Prompts
+# Non-interactive, defaults only
+pnpm create vexcms@alpha my-app --yes
 
-The CLI walks you through:
+# Inside a pnpm workspace, catalog-aware
+pnpm create vexcms@alpha my-app --monorepo --yes
+```
 
-1. **Project name** — validates npm package name rules, supports `.` for current directory
-2. **Framework** — Next.js (recommended) or TanStack Start (coming soon)
-3. **Email/password auth** — enable or disable (default: yes)
-4. **OAuth providers** — multi-select from 30+ Better Auth providers (Google, GitHub, Discord, etc.)
-5. **Organizations** — enable multi-tenant support (default: no, skipped if `--orgs` passed)
-6. **Git repository** — initialize git (default: yes)
-7. **Install dependencies** — run package install (default: no)
+## Interactive prompts
 
-## Templates
+Skipped entirely by `--yes` (each falls back to its default); otherwise the CLI walks you
+through:
 
-### Marketing Site (default)
+1. **Project name** — validates npm package name rules; `.` scaffolds into the current directory
+2. **Framework** — Next.js (TanStack Start is not yet implemented)
+3. **Dev server port** — default `3010`
+4. **Email/password auth** — enable or disable (default: yes)
+5. **Organizations** — multi-tenant support (default: no; skipped if `--orgs` was passed)
+6. **OAuth providers** — multi-select from Better Auth's supported providers
+7. **Git repository** — run `git init` (default: yes; skipped under `--monorepo`)
+8. **Install dependencies** — run the package manager install (default: no; skipped under `--monorepo`)
 
-Pre-built collections for a marketing website:
-
-- **Pages** — with title, slug, richtext content, draft/publish versioning, and live preview
-- **Headers** — name, logo upload, sticky option
-- **Footers** — name, richtext content, copyright text
-- **Themes** — name, colors, font family
-- **Site Settings** — site name, description, favicon upload
+## Templates
 
-Also includes:
+### `base-nextjs`
 
-- Landing page with sign-in/sign-up flow
-- First-user auto-admin promotion
-- Admin panel onboarding tour (driver.js)
-- Preview routes at `/preview/[slug]` with live preview support
-- Public page routes at `/[slug]` (published pages only)
-- Draft-aware queries using `vexQuery`
+The foundation every scaffold starts from — used alone when `--bare` is passed:
 
-### Bare (`--bare`)
+- Better Auth wired through `@vexcms/better-auth`, with email/password and any selected OAuth
+  providers
+- Admin panel mounted at `/admin` via `@vexcms/next`
+- Media collection backed by `@vexcms/file-storage-convex`
+- Users collection merged from the auth adapter
+- First-admin bootstrap: the first account created anywhere in the project is auto-promoted to
+  admin (`convex/vex/firstUser.ts`); until then, the home route renders a `WelcomePage` prompting
+  sign-up instead of a `404`
+- No pages, blocks, themes, or site content — `vex.config.ts` ships an empty `collections: []`
+  overlay slot
 
-Empty VEX CMS project with:
+### `marketing-site` (default)
 
-- Authentication setup (Better Auth + Convex adapter)
-- Admin panel wired at `/admin`
-- Empty `collections: []` in `vex.config.ts`
-- No onboarding tour
+An overlay applied over `base-nextjs` with file-level overwrite, adding a complete marketing
+site:
 
-## Getting Started
+- Collections: `pages`, `headers`, `footers`, `themes` (with a `themeColors` sub-shape)
+- Global: `siteSettings` (active theme, admin theme, site name)
+- 8 content blocks (`blocks/<Name>/{config.ts,index.tsx}`) rendered anywhere via `RenderBlocks`
+  from `@vexcms/react` — no hand-rolled block-type switch
+- Theme system: database-driven CSS custom properties (`ThemeStyle` for first paint,
+  `ThemeLive` for live updates), seeded with four starter palettes
+- `convex/seed.ts` — an idempotent `init` mutation seeding site settings, a header, a footer, the
+  starter palettes, and a complete home page from the blocks' own defaults (`pnpm seed`)
 
-After scaffolding your project:
+## Getting started
 
-### 1. Install dependencies
+After scaffolding:
 
 ```bash
 cd my-project
-pnpm install
+pnpm install            # skip if you answered "yes" to install during scaffolding
 ```
 
-### 2. Generate a Better Auth secret
+### 1. Stand up your Convex deployment
 
 ```bash
-pnpm secret:create
+npx convex dev
 ```
 
-This generates a random 32-character string and copies it to your clipboard.
+First run only — links or creates a Convex project and prints your real
+`NEXT_PUBLIC_CONVEX_URL` and `NEXT_PUBLIC_CONVEX_SITE_URL`. Paste them into `.env.local`,
+replacing the generated placeholder values so the app stops pointing at
+`https://placeholder.convex.cloud`. Leave `Ctrl-C` once it reports functions are ready.
 
-### 3. Configure environment variables
+`next.config.ts` derives `images.remotePatterns` from `NEXT_PUBLIC_CONVEX_URL`
+automatically, so `next/image` picks up the real deployment's hostname without any
+further edits.
 
-The CLI creates a `.env.local` file with `NEXT_PUBLIC_SITE_URL` set to your chosen port. Add the auth secret:
+### 2. Configure environment variables
 
-```env
-# .env.local (auto-generated)
-NEXT_PUBLIC_SITE_URL=http://localhost:3010
+The installer writes `.env.local` with a generated `BETTER_AUTH_SECRET`,
+`NEXT_PUBLIC_SITE_URL`, and `SITE_URL` already filled in — only the two Convex URLs above need
+replacing for local dev.
 
-# Add manually:
-BETTER_AUTH_SECRET=your-generated-secret-here
-```
-
-### 4. Start VEX dev server
+Better Auth runs *inside* the Convex deployment, not the Next.js server, so it never reads
+`.env.local`. Push the same two values to the deployment itself:
 
 ```bash
-pnpm vex:dev
+npx convex env set SITE_URL http://localhost:3010
+npx convex env set BETTER_AUTH_SECRET <the BETTER_AUTH_SECRET value from .env.local>
 ```
 
-This starts the VEX CLI watcher (generates schema, types, and queries) and the Convex dev server. On first run, it will prompt you to create or select a Convex project.
-
-### 5. Add environment variables to Convex
-
-In the [Convex Dashboard](https://dashboard.convex.dev), navigate to your project's **Settings > Environment Variables** and add:
+Skipping this step is the most common cause of a `403` on the first sign-in attempt.
 
-- `BETTER_AUTH_SECRET` — the same secret from step 2
-- `SITE_URL` — `http://localhost:3010` (or your chosen port)
-
-### 6. Start the Next.js dev server
-
-In a separate terminal:
+### 3. Run the dev servers
 
 ```bash
-pnpm dev
+pnpm dev        # Next.js + convex dev + the vex config watcher, together
 ```
 
-### 7. Create your admin account
+### 4. Create your admin account
 
-Open `http://localhost:3010` in your browser. Click **"Create Admin Account"** to sign up. The first user is automatically promoted to admin and redirected to the admin panel.
+Open `http://localhost:3010` (or your chosen port) and sign up. The first account created is
+automatically promoted to admin and redirected into `/admin`.
 
-### Available Scripts
+### Available scripts
 
 | Script | Description |
 |--------|-------------|
-| `pnpm dev` | Start Next.js development server |
-| `pnpm vex:dev` | Start VEX CLI watcher + Convex dev server |
-| `pnpm vex:generate` | One-shot schema/type/query generation |
-| `pnpm vex:update` | Update all `@vexcms/*` packages to latest |
-| `pnpm secret:create` | Generate a random 32-character secret and copy to clipboard |
+| `pnpm dev` | Start Next.js, `convex dev`, and the `vex` watcher together |
 | `pnpm build` | Production build |
+| `pnpm typecheck` | Type-check the project |
+| `pnpm seed` | Run the marketing-site seed mutation (marketing-site only) |
+| `pnpm secret:create` | Generate a random 32-character secret and copy it to the clipboard |
+
+## Monorepo mode (`--monorepo`)
+
+Run from inside an existing pnpm workspace to scaffold a new app under it instead of a
+standalone project:
+
+```bash
+pnpm create vexcms@alpha my-app --monorepo --yes
+```
+
+The installer walks up from the current directory for the nearest `pnpm-workspace.yaml`, targets
+`apps/my-app`, rewrites every `@vexcms/*` dependency to `workspace:*` and any dependency also
+present in the host workspace's catalog to `catalog:` (other dependencies keep literal
+versions), and skips both `git init` and dependency install — the root workspace owns them.
 
 ## Versioning
 
-`create-vexcms` is versioned alongside all `@vexcms/*` packages. Running `pnpm create vexcms@latest` always scaffolds with the latest package versions. You can also pin a specific version:
+`create-vexcms` is versioned alongside every `@vexcms/*` package. Running
+`pnpm create vexcms@alpha` always scaffolds with the newest pre-release. The npm
+`latest` tag still points at an old, unrelated `0.0.20` line, so `@alpha` — or an
+exact version — is the only way to get the current API:
 
 ```bash
-pnpm create vexcms@0.0.3
+pnpm create vexcms@0.1.0-alpha.10
 ```
 
-The scaffolded project's `@vexcms/*` dependencies match the version of `create-vexcms` used.
+The scaffolded project's `@vexcms/*` dependencies match the version of `create-vexcms` used to
+generate it.
 
 ## License
 
-MIT
+Apache-2.0