@clubedge/create-clubedge-app 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to `create-clubedge-app` are documented here.
+
+## 0.1.0
+
+- Initial CLI release: scaffold the Clubedge Starter reference repository into a new project directory.
+- Add project naming, environment file setup, optional dependency installation, Git initialization, and starter ref selection.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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/NOTICE

@@ -0,0 +1,6 @@
+Clubedge Starter
+Copyright 2026 Clubedge Digital Systems
+
+This project is licensed under the Apache License, Version 2.0.
+The license text is available in the LICENSE file and at
+https://www.apache.org/licenses/LICENSE-2.0.

package/README.md

@@ -1,3 +1,84 @@
-# Temporary Holding Version
+# create-clubedge-app
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![CI](https://github.com/yassine-ahmed/create-clubedge-app/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/yassine-ahmed/create-clubedge-app/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE)
+
+Create a Next.js application from the [Clubedge Starter](https://github.com/yassine-ahmed/clubedge-starter) reference implementation.
+
+The CLI downloads the starter repository, names the generated project, creates `apps/web/.env.local` from the example, initializes Git, and installs dependencies. The starter remains the source of truth for the generated architecture.
+
+## Requirements
+
+- Node.js 22.12 or newer.
+- pnpm 10.9.0 or newer (the generated starter uses Corepack and pnpm).
+- Git, when using the default Git initialization.
+- Internet access to download the starter from GitHub and install dependencies.
+
+## Usage
+
+```sh
+pnpm dlx @clubedge/create-clubedge-app my-app
+```
+
+Or run it with npm:
+
+```sh
+npx @clubedge/create-clubedge-app my-app
+```
+
+After scaffolding:
+
+```sh
+cd my-app
+pnpm dev
+```
+
+The generated project includes `.env.local`; fill in `DATABASE_URL` to start the app and configure Supabase Auth or other providers as needed. See its `SETUP.md` for database, Redis, storage, and Docker setup.
+
+When no destination is provided, the CLI asks where to create the project:
+
+```sh
+pnpm dlx @clubedge/create-clubedge-app
+```
+
+## Options
+
+```text
+Usage: pnpm dlx @clubedge/create-clubedge-app [project-directory] [options]
+
+--ref <branch-or-tag>  Select a branch or tag from the starter repository (default: main)
+--no-install           Skip pnpm install
+--no-git               Skip Git initialization
+-h, --help             Show help
+-v, --version          Show the CLI version
+```
+
+Examples:
+
+```sh
+pnpm dlx @clubedge/create-clubedge-app my-app --ref v1.0.0
+pnpm dlx @clubedge/create-clubedge-app my-app --no-install
+```
+
+The target directory must be empty or not exist. The CLI will not delete or overwrite files in a non-empty target directory. The default `main` ref follows the current reference implementation; use a tag to scaffold a specific starter revision.
+
+## How it works
+
+This first CLI release scaffolds the complete reference starter. It does not yet offer selectable SaaS, dashboard, or minimal feature presets; those should be added once each preset has a distinct, maintained template. This keeps CLI output aligned with the reference repo instead of creating a second, drifting copy of its source.
+
+## Development
+
+```sh
+corepack enable
+pnpm install
+node ./bin/create.mjs --help
+pnpm check
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development and pull request guidance. Report vulnerabilities privately as described in [SECURITY.md](SECURITY.md).
+
+## License
+
+Copyright 2026 Clubedge Digital Systems. Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).

package/bin/create.mjs

@@ -0,0 +1,260 @@
+#!/usr/bin/env node
+
+import { cancel, intro, isCancel, outro, spinner, text } from "@clack/prompts";
+import { downloadTemplate } from "giget";
+import { cp, mkdir, readdir, readFile, writeFile } from "node:fs/promises";
+import { spawn } from "node:child_process";
+import { basename, dirname, join, resolve } from "node:path";
+import process from "node:process";
+
+const starterRepository = "yassine-ahmed/clubedge-starter";
+const defaultRef = "main";
+const packageVersion = JSON.parse(
+  await readFile(new URL("../package.json", import.meta.url), "utf8"),
+).version;
+
+function showHelp() {
+  console.log(`
+create-clubedge-app ${packageVersion}
+
+Create a Next.js project from the Clubedge Starter reference repository.
+
+Usage:
+  pnpm dlx @clubedge/create-clubedge-app [project-directory] [options]
+
+Options:
+  --ref <branch-or-tag>  Starter branch or tag to scaffold (default: ${defaultRef})
+  --no-install           Skip dependency installation
+  --no-git               Skip Git repository initialization
+  -h, --help             Show this help
+  -v, --version          Show the CLI version
+
+Examples:
+  pnpm dlx @clubedge/create-clubedge-app my-app
+  pnpm dlx @clubedge/create-clubedge-app my-app --ref v1.0.0
+  pnpm dlx @clubedge/create-clubedge-app my-app --no-install
+`);
+}
+
+function parseArguments(args) {
+  const options = { install: true, git: true, ref: defaultRef, projectDirectory: undefined };
+
+  for (let index = 0; index < args.length; index += 1) {
+    const argument = args[index];
+
+    if (argument === "--help" || argument === "-h") {
+      return { ...options, help: true };
+    }
+    if (argument === "--version" || argument === "-v") {
+      return { ...options, version: true };
+    }
+    if (argument === "--no-install") {
+      options.install = false;
+      continue;
+    }
+    if (argument === "--no-git") {
+      options.git = false;
+      continue;
+    }
+    if (argument === "--ref" || argument.startsWith("--ref=")) {
+      const value = argument === "--ref" ? args[++index] : argument.slice("--ref=".length);
+      if (!value || value.startsWith("-")) {
+        throw new Error("--ref requires a branch or tag name.");
+      }
+      options.ref = value;
+      continue;
+    }
+    if (argument.startsWith("-")) {
+      throw new Error(`Unknown option: ${argument}. Run with --help to see available options.`);
+    }
+    if (options.projectDirectory) {
+      throw new Error("Only one project directory can be provided.");
+    }
+    options.projectDirectory = argument;
+  }
+
+  return options;
+}
+
+function isCancelled(value) {
+  if (isCancel(value)) {
+    cancel("Operation cancelled.");
+    process.exit(0);
+  }
+  return value;
+}
+
+function packageNameFromDirectory(directory) {
+  return (
+    basename(directory)
+      .toLowerCase()
+      .replace(/[^a-z0-9._-]+/g, "-")
+      .replace(/^[._-]+|[._-]+$/g, "") || "my-app"
+  );
+}
+
+function displayNameFromPackageName(packageName) {
+  return packageName
+    .split(/[-._]+/)
+    .filter(Boolean)
+    .map((part) => part[0].toUpperCase() + part.slice(1))
+    .join(" ");
+}
+
+async function run(command, args, cwd) {
+  await new Promise((resolvePromise, rejectPromise) => {
+    const child = spawn(command, args, {
+      cwd,
+      stdio: "inherit",
+      shell: process.platform === "win32",
+    });
+
+    child.once("error", rejectPromise);
+    child.once("exit", (code, signal) => {
+      if (code === 0) {
+        resolvePromise();
+        return;
+      }
+      rejectPromise(new Error(`${command} exited with ${signal ? `signal ${signal}` : `code ${code}`}.`));
+    });
+  });
+}
+
+async function ensureTargetIsSafe(directory) {
+  await mkdir(dirname(directory), { recursive: true });
+
+  try {
+    const entries = await readdir(directory);
+    if (entries.length > 0) {
+      throw new Error(`The target directory is not empty: ${directory}`);
+    }
+  } catch (error) {
+    if (error && typeof error === "object" && "code" in error && error.code === "ENOENT") {
+      return;
+    }
+    throw error;
+  }
+}
+
+async function customizeProject(directory, packageName) {
+  const rootManifestPath = join(directory, "package.json");
+  const rootManifest = JSON.parse(await readFile(rootManifestPath, "utf8"));
+  rootManifest.name = packageName;
+
+  for (const scriptName of ["docker:build", "docker:start"]) {
+    if (rootManifest.scripts?.[scriptName]) {
+      rootManifest.scripts[scriptName] = rootManifest.scripts[scriptName].replace(
+        /clubedge-starter/g,
+        packageName,
+      );
+    }
+  }
+  await writeFile(rootManifestPath, `${JSON.stringify(rootManifest, null, 2)}\n`);
+
+  const readmePath = join(directory, "README.md");
+  const readme = await readFile(readmePath, "utf8");
+  const displayName = displayNameFromPackageName(packageName);
+  await writeFile(readmePath, readme.replace(/^# Clubedge Starter$/m, `# ${displayName}`));
+
+  const layoutPath = join(directory, "apps", "web", "src", "app", "layout.tsx");
+  const layout = await readFile(layoutPath, "utf8");
+  const customizedLayout = layout
+    .replaceAll('"Clubedge Starter"', JSON.stringify(displayName))
+    .replace("A production-minded foundation for Clubedge applications.", `A web application built with Clubedge Starter.`);
+  await writeFile(layoutPath, customizedLayout);
+
+  const exampleEnvironment = join(directory, ".env.example");
+  const localEnvironment = join(directory, "apps", "web", ".env.local");
+  await cp(exampleEnvironment, localEnvironment, { errorOnExist: true });
+}
+
+async function initializeGit(directory) {
+  try {
+    await run("git", ["init", "-b", "main"], directory);
+  } catch {
+    await run("git", ["init"], directory);
+    await run("git", ["branch", "-M", "main"], directory);
+  }
+}
+
+async function createProject(options) {
+  let requestedDirectory = options.projectDirectory;
+  if (!requestedDirectory) {
+    requestedDirectory = isCancelled(
+      await text({
+        message: "Where should the new project be created?",
+        placeholder: "my-app",
+        validate(value) {
+          if (!value.trim()) return "Enter a project directory name.";
+        },
+      }),
+    );
+  }
+
+  const projectDirectory = resolve(process.cwd(), requestedDirectory);
+  if (projectDirectory === resolve(dirname(projectDirectory))) {
+    throw new Error("Choose a project subdirectory rather than a filesystem root.");
+  }
+
+  await ensureTargetIsSafe(projectDirectory);
+
+  const projectName = packageNameFromDirectory(projectDirectory);
+  const source = `gh:${starterRepository}#${options.ref}`;
+  const downloadSpinner = spinner();
+  downloadSpinner.start(`Downloading Clubedge Starter (${options.ref})`);
+  try {
+    await downloadTemplate(source, { dir: projectDirectory, force: true });
+    await customizeProject(projectDirectory, projectName);
+    downloadSpinner.stop("Starter files downloaded and configured");
+  } catch (error) {
+    downloadSpinner.stop("Project scaffold failed");
+    throw error;
+  }
+
+  if (options.git) {
+    const gitSpinner = spinner();
+    gitSpinner.start("Initializing Git");
+    await initializeGit(projectDirectory);
+    gitSpinner.stop("Git repository initialized on main");
+  }
+
+  if (options.install) {
+    const installSpinner = spinner();
+    installSpinner.start("Installing dependencies with pnpm");
+    try {
+      await run("pnpm", ["install"], projectDirectory);
+      installSpinner.stop("Dependencies installed");
+    } catch (error) {
+      installSpinner.stop("Project created; dependency installation did not complete");
+      console.error(error instanceof Error ? error.message : error);
+      console.error("Install pnpm with Corepack, then run `pnpm install` in the new project.");
+    }
+  }
+
+  const relativeDirectory = process.cwd() === projectDirectory ? "." : requestedDirectory;
+  outro(
+    `Created ${projectName}.\n\nNext steps:\n  cd ${relativeDirectory}\n  pnpm dev\n\nSee SETUP.md for database and provider configuration.`,
+  );
+}
+
+async function main() {
+  try {
+    const options = parseArguments(process.argv.slice(2));
+    if (options.help) {
+      showHelp();
+      return;
+    }
+    if (options.version) {
+      console.log(packageVersion);
+      return;
+    }
+
+    intro("Create a project with Clubedge Starter");
+    await createProject(options);
+  } catch (error) {
+    console.error(`\n${error instanceof Error ? error.message : String(error)}`);
+    process.exitCode = 1;
+  }
+}
+
+await main();

package/package.json

@@ -1,6 +1,44 @@
 {
   "name": "@clubedge/create-clubedge-app",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Create a Next.js application from the Clubedge Starter reference implementation.",
+  "type": "module",
+  "packageManager": "pnpm@10.9.0",
+  "bin": {
+    "create-clubedge-app": "./bin/create.mjs"
+  },
+  "files": [
+    "bin/",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yassine-ahmed/create-clubedge-app.git"
+  },
+  "homepage": "https://github.com/yassine-ahmed/create-clubedge-app#readme",
+  "bugs": {
+    "url": "https://github.com/yassine-ahmed/create-clubedge-app/issues"
+  },
+  "keywords": [
+    "create-clubedge-app",
+    "clubedge",
+    "nextjs",
+    "starter",
+    "scaffolding"
+  ],
+  "scripts": {
+    "start": "node ./bin/create.mjs",
+    "check": "node --check ./bin/create.mjs"
+  },
+  "dependencies": {
+    "@clack/prompts": "^1.8.1",
+    "giget": "^2.0.0"
+  }
+}