create-oxom-app 0.1.0

package/README.md

@@ -0,0 +1,27 @@
+# create-oxom-app
+
+Scaffold a new [plattform](https://github.com/oxom-de/plattform) workspace in seconds.
+
+```bash
+npx create-oxom-app my-workspace
+```
+
+Or interactively:
+
+```bash
+npx create-oxom-app
+```
+
+## What it does
+
+1. Clones the latest `plattform` template from GitHub
+2. Asks for a project name and brand name
+3. Writes a `.env.local` with your brand name pre-filled
+4. Runs `pnpm install` (falls back to `bun` or `npm`)
+5. Prints the next steps
+
+## Requirements
+
+- Node.js 20+
+- git
+- pnpm (recommended), bun, or npm

package/bin/create-oxom-app.js

@@ -0,0 +1,129 @@
+#!/usr/bin/env node
+
+import { execSync } from "node:child_process";
+import { createInterface } from "node:readline";
+import { existsSync, rmSync, readFileSync, writeFileSync, copyFileSync } from "node:fs";
+import { resolve, join } from "node:path";
+
+// ── Config ─────────────────────────────────────────────────────────────────
+
+const REPO_URL = "https://github.com/oxom-de/plattform.git";
+const REPO_DISPLAY = "github.com/oxom-de/plattform";
+
+// ── Helpers ────────────────────────────────────────────────────────────────
+
+const cyan = (s) => `\x1b[36m${s}\x1b[0m`;
+const green = (s) => `\x1b[32m${s}\x1b[0m`;
+const bold = (s) => `\x1b[1m${s}\x1b[0m`;
+const dim = (s) => `\x1b[2m${s}\x1b[0m`;
+
+function prompt(rl, question) {
+  return new Promise((resolve) => rl.question(question, resolve));
+}
+
+function run(cmd, cwd) {
+  execSync(cmd, { cwd, stdio: "inherit" });
+}
+
+function hasBin(bin) {
+  try {
+    execSync(`which ${bin}`, { stdio: "ignore" });
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+// ── Main ───────────────────────────────────────────────────────────────────
+
+const rl = createInterface({ input: process.stdin, output: process.stdout });
+
+console.log(`\n${bold("create-oxom-app")}  ${dim(`→ ${REPO_DISPLAY}`)}\n`);
+
+// 1. Project name
+let projectName = process.argv[2]?.trim();
+if (!projectName) {
+  projectName = (await prompt(rl, `Project name ${dim("(my-workspace)")}  `)).trim() || "my-workspace";
+}
+
+const projectDir = resolve(process.cwd(), projectName);
+if (existsSync(projectDir)) {
+  console.error(`\nDirectory "${projectName}" already exists. Choose a different name.\n`);
+  rl.close();
+  process.exit(1);
+}
+
+// 2. Brand name
+const brandName = (await prompt(rl, `Brand name    ${dim(`(${projectName})`)}  `)).trim() || projectName;
+
+rl.close();
+
+// 3. Clone
+console.log(`\n${cyan("→")} Cloning template from ${REPO_DISPLAY}…`);
+try {
+  run(`git clone --depth=1 ${REPO_URL} "${projectName}"`, process.cwd());
+} catch {
+  console.error("\nFailed to clone repository. Make sure git is installed and you have internet access.\n");
+  process.exit(1);
+}
+
+// Remove git history so the user starts fresh
+rmSync(join(projectDir, ".git"), { recursive: true, force: true });
+
+// 4. Patch package.json name
+const pkgPath = join(projectDir, "package.json");
+const pkg = JSON.parse(readFileSync(pkgPath, "utf8"));
+pkg.name = projectName;
+writeFileSync(pkgPath, JSON.stringify(pkg, null, "\t") + "\n");
+
+// 5. Write .env.local from example
+const envExamplePath = join(projectDir, ".env.local.example");
+const envLocalPath = join(projectDir, ".env.local");
+
+if (existsSync(envExamplePath)) {
+  let env = readFileSync(envExamplePath, "utf8");
+  // Patch brand name
+  env = env.replace(
+    /^NEXT_PUBLIC_BRAND_NAME=.*/m,
+    `NEXT_PUBLIC_BRAND_NAME=${brandName}`,
+  );
+  writeFileSync(envLocalPath, env);
+} else {
+  writeFileSync(
+    envLocalPath,
+    `NEXT_PUBLIC_BRAND_NAME=${brandName}\nNEXT_PUBLIC_APP_URL=http://localhost:3000\n`,
+  );
+}
+
+// 6. Install dependencies
+const pm = hasBin("pnpm") ? "pnpm" : hasBin("bun") ? "bun" : "npm";
+console.log(`\n${cyan("→")} Installing dependencies with ${pm}…\n`);
+try {
+  run(`${pm} install`, projectDir);
+} catch {
+  console.warn("\nDependency install failed — run it manually inside the project directory.\n");
+}
+
+// 7. Done
+console.log(`
+${green("✓")} ${bold(projectName)} is ready.
+
+${bold("Next steps:")}
+
+  ${cyan(`cd ${projectName}`)}
+  ${dim("# Fill in your credentials:")}
+  ${cyan("open .env.local")}
+  ${dim("# Apply database migrations to your Supabase project:")}
+  ${dim("# → supabase/migrations/")}
+  ${cyan(`${pm} dev`)}
+
+${bold("Services you need:")}
+
+  Clerk       https://clerk.com
+  Supabase    https://supabase.com
+  Liveblocks  https://liveblocks.io
+  Dub         https://dub.co          ${dim("(optional — link shortening)")}
+  R2 / S3                             ${dim("(optional — configure per workspace in Settings → Drive)")}
+
+${dim(`Docs: ${REPO_DISPLAY}#readme`)}
+`);

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "create-oxom-app",
+  "version": "0.1.0",
+  "description": "Create a new plattform workspace app",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "create-oxom-app": "./bin/create-oxom-app.js"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "keywords": [
+    "create-app",
+    "plattform",
+    "workspace",
+    "nextjs",
+    "clerk",
+    "supabase"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/oxom-de/create-oxom-app"
+  }
+}