@rellcodes16/devkit 1.0.0

package/README.md

@@ -0,0 +1,128 @@
+# devkit
+
+Personal project scaffolding CLI. Spin up a full Node.js or React + Vite project with your standard stack in one command.
+
+## Install
+
+```bash
+git clone https://github.com/rellcodes16/devkit.git
+cd devkit
+bash install.sh
+```
+
+Or manually:
+
+```bash
+npm install
+npm link
+```
+
+## Usage
+
+```bash
+# Node.js + Express
+devkit node <appname>
+
+# React + Vite + Tailwind
+devkit react <appname>
+```
+
+## Options
+
+### `devkit node <appname>`
+
+| Flag | Description |
+|---|---|
+| `--mongo` | Add Mongoose (MongoDB) setup |
+| `--prisma` | Add Prisma ORM + schema setup |
+| `--turso` | Add Turso (LibSQL) client |
+| `--pg` | Add postgres.js (PostgreSQL) setup |
+| `--supabase` | Add Supabase JS client |
+| `--drizzle` | Add Drizzle ORM (must be paired with `--turso` or `--pg`) |
+| `--redis` | Add Redis (ioredis) setup |
+| `--cloudinary` | Add Cloudinary + Multer setup |
+| `--socket` | Add Socket.IO |
+| `--github` | Create and push to a GitHub repo (requires `gh` CLI installed + logged in) |
+| `--no-git` | Skip git init |
+
+> Only one primary database flag (`--mongo`, `--prisma`, `--turso`, `--pg`, `--supabase`) can be used at a time. `--redis` can be paired with any of them.
+
+### `devkit react <appname>`
+
+| Flag | Description |
+|---|---|
+| `--router` | Add React Router DOM |
+| `--axios` | Add Axios |
+| `--github` | Create and push to a GitHub repo (requires `gh` CLI installed + logged in) |
+| `--no-git` | Skip git init |
+
+## Examples
+
+```bash
+devkit node my-api                       # Express + standard middleware, no DB
+devkit node my-api --mongo               # + Mongoose (MongoDB)
+devkit node my-api --pg --drizzle        # + PostgreSQL with Drizzle ORM
+devkit node my-api --turso --drizzle     # + Turso (LibSQL) with Drizzle ORM
+devkit node my-api --supabase --redis    # + Supabase + Redis cache
+devkit node my-api --mongo --cloudinary  # + Mongoose + Cloudinary uploads
+devkit node my-api --mongo --github      # + Mongoose, then create & push GitHub repo
+
+devkit react my-app                      # React + Vite + Tailwind
+devkit react my-app --router             # + React Router DOM
+devkit react my-app --router --axios     # + React Router + Axios
+devkit react my-app --axios --github     # + Axios, then create & push GitHub repo
+```
+
+## GitHub repo creation
+
+The `--github` flag uses the [GitHub CLI](https://cli.github.com) to create a repo and push your initial commit automatically. It requires:
+
+1. The `gh` CLI installed (`winget install --id GitHub.cli` on Windows)
+2. Being logged in once via `gh auth login`
+
+Without `--github`, devkit only runs `git init` locally — no remote repo is created.
+
+## What gets scaffolded
+
+### Node project
+```
+<appname>/
+  src/
+    routes/         # Express routers
+    controllers/    # Handler logic
+    middleware/     # errorHandler.js, notFound.js, asyncHandler.js
+    config/         # DB config, redis.js, cloudinary.js (depending on flags)
+    models/         # Mongoose models (if --mongo)
+    index.js        # Entry point with all middleware wired up
+  prisma/           # (if --prisma)
+    schema.prisma
+  drizzle/          # (if --drizzle)
+  .env + .env.example
+  .gitignore
+  package.json      # nodemon dev script included
+  README.md
+```
+
+### React project
+```
+<appname>/
+  src/
+    components/
+    pages/
+    hooks/
+    utils/
+      api.js        # Pre-configured axios instance (if --axios)
+    assets/
+    App.jsx         # Clean starting point (with Router if --router)
+    index.css       # Tailwind directives + base styles
+  vite.config.js
+  .env + .env.example   # VITE_API_URL pre-set
+  .gitignore
+  README.md
+```
+
+## Uninstall
+
+```bash
+npm unlink -g devkit
+```

package/bin/devkit.js

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+import { program } from "commander";
+import { createNodeProject } from "../src/commands/createNode.js";
+import { createReactProject } from "../src/commands/createReact.js";
+import kleur from "kleur";
+
+const VERSION = "1.0.0";
+
+console.log(kleur.bold().cyan(`\n  devkit CLI tool v${VERSION} \n`));
+
+program
+  .name("devkit")
+  .description("Spin up Node or React projects instantly with your standard stack")
+  .version(VERSION);
+
+program
+  .command("node <appname>")
+  .description("Scaffold a Node.js + Express project")
+  .option("--no-git", "skip git init")
+  .option("--github", "create and push to a GitHub repo (requires gh CLI + login)")
+  .option("--mongo", "include Mongoose (MongoDB)")
+  .option("--prisma", "include Prisma ORM setup")
+  .option("--turso", "include Turso (LibSQL) client")
+  .option("--pg", "include postgres.js (PostgreSQL)")
+  .option("--supabase", "include Supabase JS client")
+  .option("--redis", "include Redis (ioredis)")
+  .option("--drizzle", "include Drizzle ORM (pair with --turso or --pg)")
+  .option("--cloudinary", "include Cloudinary + Multer")
+  .option("--socket", "include Socket.IO")
+  .action((appname, options) => {
+    createNodeProject(appname, options);
+  });
+
+program
+  .command("react <appname>")
+  .description("Scaffold a React + Vite project")
+  .option("--no-git", "skip git init")
+  .option("--github", "create and push to a GitHub repo (requires gh CLI + login)")
+  .option("--router", "include React Router DOM")
+  .option("--axios", "include Axios for HTTP requests")
+  .action((appname, options) => {
+    createReactProject(appname, options);
+  });
+
+program.on("command:*", () => {
+  console.error(kleur.red(`  Unknown command: ${program.args.join(" ")}\n`));
+  console.log(`  Run ${kleur.cyan("devkit --help")} to see available commands.\n`);
+  process.exit(1);
+});
+
+program.parse(process.argv);
+
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@rellcodes16/devkit",
+  "version": "1.0.0",
+  "description": "Personal project scaffolding CLI — spin up Node or React projects instantly",
+  "type": "module",
+  "bin": {
+    "devkit": "./bin/devkit.js"
+  },
+  "files": [
+    "bin/",
+    "src/"
+  ],
+  "scripts": {
+    "test": "node bin/devkit.js --help"
+  },
+  "keywords": [
+    "cli",
+    "scaffold",
+    "express",
+    "react",
+    "vite",
+    "tailwind",
+    "boilerplate"
+  ],
+  "author": "rellcodes16",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rellcodes16/devkit"
+  },
+  "homepage": "https://github.com/rellcodes16/devkit#readme",
+  "dependencies": {
+    "commander": "^12.0.0",
+    "execa": "^8.0.1",
+    "fs-extra": "^11.2.0",
+    "kleur": "^4.1.5",
+    "ora": "^8.0.1"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/src/commands/createNode.js

@@ -0,0 +1,219 @@
+import path from "path";
+import fs from "fs-extra";
+import kleur from "kleur";
+import {
+  printStep,
+  printError,
+  printDivider,
+  runCommand,
+  printDoneMessage,
+} from "../utils.js";
+import {
+  nodePackageJson,
+  nodeIndexJs,
+  nodeEnv,
+  nodeGitignore,
+  nodeReadme,
+  nodeMongoConfig,
+  nodePrismaConfig,
+  nodePrismaSchema,
+  nodeTursoConfig,
+  nodeTursoWithDrizzleConfig,
+  nodeTursoSchema,
+  nodeDrizzleConfig,
+  nodePgConfig,
+  nodePgWithDrizzleConfig,
+  nodePgSchema,
+  nodeSupabaseConfig,
+  nodeRedisConfig,
+  nodeCloudinaryConfig,
+  nodeErrorHandler,
+  nodeNotFound,
+  nodeAsyncHandler,
+  nodeRoutes,
+  nodeUserModel,
+} from "../templates/node/index.js";
+
+export async function createNodeProject(appname, options) {
+  const targetDir = path.resolve(process.cwd(), appname);
+
+  if (fs.existsSync(targetDir)) {
+    printError(`Folder "${appname}" already exists. Choose a different name.`);
+    process.exit(1);
+  }
+
+  // Only one primary DB allowed
+  const dbFlags = [options.mongo, options.prisma, options.turso, options.pg, options.supabase].filter(Boolean);
+  if (dbFlags.length > 1) {
+    printError(
+      "Please choose only one database option: --mongo, --prisma, --turso, --pg, or --supabase.\n" +
+      "  Redis (--redis) can be paired with any of the above."
+    );
+    process.exit(1);
+  }
+
+  // pair --drizzle with only --turso or --pg
+  if (options.drizzle && !options.turso && !options.pg) {
+    printError("--drizzle must be paired with --turso or --pg.");
+    process.exit(1);
+  }
+
+  console.log(kleur.bold(`  Setting up Node.js project: ${kleur.cyan(appname)}\n`));
+  printDivider();
+
+  printStep("Creating project structure...");
+
+  const dirs = [
+    "src/routes",
+    "src/controllers",
+    "src/middleware",
+    "src/config",
+    "public",
+  ];
+
+  if (options.mongo)  dirs.push("src/models");
+  if (options.drizzle) dirs.push("drizzle");
+
+  for (const dir of dirs) {
+    fs.mkdirSync(path.join(targetDir, dir), { recursive: true });
+    if (!["public", "drizzle"].includes(dir)) {
+      fs.writeFileSync(path.join(targetDir, dir, ".gitkeep"), "");
+    }
+  }
+
+  fs.writeFileSync(path.join(targetDir, "public/favicon.ico"), "");
+
+  printStep("Writing base files...");
+
+  fs.writeFileSync(path.join(targetDir, "package.json"),  nodePackageJson(appname, options));
+  fs.writeFileSync(path.join(targetDir, "src/index.js"),  nodeIndexJs(options));
+  fs.writeFileSync(path.join(targetDir, ".env"),          nodeEnv(options));
+  fs.writeFileSync(path.join(targetDir, ".env.example"),  nodeEnv(options));
+  fs.writeFileSync(path.join(targetDir, ".gitignore"),    nodeGitignore());
+  fs.writeFileSync(path.join(targetDir, "README.md"),     nodeReadme(appname, options));
+
+  fs.writeFileSync(path.join(targetDir, "src/routes/index.js"),          nodeRoutes());
+  fs.writeFileSync(path.join(targetDir, "src/middleware/errorHandler.js"), nodeErrorHandler());
+  fs.writeFileSync(path.join(targetDir, "src/middleware/notFound.js"),    nodeNotFound());
+  fs.writeFileSync(path.join(targetDir, "src/middleware/asyncHandler.js"), nodeAsyncHandler());
+
+  if (options.mongo) {
+    printStep("Adding Mongoose setup...");
+    fs.writeFileSync(path.join(targetDir, "src/config/db.js"), nodeMongoConfig());
+    fs.writeFileSync(
+      path.join(targetDir, "src/models/User.js"),
+      nodeUserModel(options.cloudinary)
+    );
+  }
+
+  if (options.prisma) {
+    printStep("Adding Prisma setup...");
+    fs.mkdirSync(path.join(targetDir, "prisma"), { recursive: true });
+    fs.writeFileSync(path.join(targetDir, "prisma/schema.prisma"), nodePrismaSchema());
+    fs.writeFileSync(path.join(targetDir, "src/config/db.js"),     nodePrismaConfig());
+  }
+
+  if (options.turso) {
+    printStep(options.drizzle ? "Adding Turso + Drizzle setup..." : "Adding Turso setup...");
+    fs.writeFileSync(
+      path.join(targetDir, "src/config/db.js"),
+      options.drizzle ? nodeTursoWithDrizzleConfig() : nodeTursoConfig()
+    );
+    if (options.drizzle) {
+      fs.writeFileSync(path.join(targetDir, "src/config/schema.js"), nodeTursoSchema());
+      fs.writeFileSync(path.join(targetDir, "drizzle.config.js"),    nodeDrizzleConfig(options));
+    }
+  }
+
+  if (options.pg) {
+    printStep(options.drizzle ? "Adding PostgreSQL + Drizzle setup..." : "Adding PostgreSQL setup...");
+    fs.writeFileSync(
+      path.join(targetDir, "src/config/db.js"),
+      options.drizzle ? nodePgWithDrizzleConfig() : nodePgConfig()
+    );
+    if (options.drizzle) {
+      fs.writeFileSync(path.join(targetDir, "src/config/schema.js"), nodePgSchema());
+      fs.writeFileSync(path.join(targetDir, "drizzle.config.js"),    nodeDrizzleConfig(options));
+    }
+  }
+
+  if (options.supabase) {
+    printStep("Adding Supabase setup...");
+    fs.writeFileSync(path.join(targetDir, "src/config/db.js"), nodeSupabaseConfig());
+  }
+
+  if (options.redis) {
+    printStep("Adding Redis setup...");
+    fs.writeFileSync(path.join(targetDir, "src/config/redis.js"), nodeRedisConfig());
+  }
+
+
+  if (options.cloudinary) {
+    printStep("Adding Cloudinary + Multer setup...");
+    fs.writeFileSync(path.join(targetDir, "src/config/cloudinary.js"), nodeCloudinaryConfig());
+  }
+  
+  printDivider();
+
+  const coreDeps = [
+    "express",
+    "cors",
+    "dotenv",
+    "morgan",
+    "helmet",
+    "cookie-parser",
+    "express-rate-limit",
+    "express-mongo-sanitize",
+    "xss-clean",
+    "serve-favicon",
+    "validator",
+    "uuid",
+    "http-errors",
+  ];
+
+  const devDeps = ["nodemon"];
+
+  if (options.mongo)    coreDeps.push("mongoose");
+  if (options.prisma)   coreDeps.push("@prisma/client");
+  if (options.turso)    coreDeps.push("@libsql/client");
+  if (options.pg)       coreDeps.push("postgres");
+  if (options.supabase) coreDeps.push("@supabase/supabase-js");
+  if (options.redis)    coreDeps.push("ioredis");
+  if (options.drizzle)  coreDeps.push("drizzle-orm");
+  if (options.socket)   coreDeps.push("socket.io");
+
+  if (options.cloudinary) {
+    coreDeps.push("cloudinary", "multer", "multer-storage-cloudinary");
+  }
+
+  if (options.prisma) devDeps.push("prisma");
+  if (options.drizzle) devDeps.push("drizzle-kit");
+
+  await runCommand("npm", ["install", ...coreDeps], targetDir, `Installing: ${coreDeps.join(", ")}`);
+  await runCommand("npm", ["install", "-D", ...devDeps], targetDir, `Installing dev deps: ${devDeps.join(", ")}`);
+
+  if (options.prisma) {
+    await runCommand("npx", ["prisma", "generate"], targetDir, "Generating Prisma client...").catch(() => {
+      // Non-fatal — DATABASE_URL not set yet
+    });
+  }
+
+  if (options.git !== false) {
+    printDivider();
+    await runCommand("git", ["init"],                                          targetDir, "Initialising git repository...");
+    await runCommand("git", ["add", "."],                                      targetDir, "Staging files...");
+    await runCommand("git", ["commit", "-m", "chore: initial scaffold via devkit"], targetDir, "Initial commit...");
+  }
+
+  if (options.github) {
+    await runCommand("gh", ["repo", "create", appname, "--public", "--source=.", "--push"], targetDir, "Creating GitHub repo...");
+  }
+
+  const extraLines = ["cp .env.example .env  # then fill in your secrets"];
+  if (options.prisma)  extraLines.push("npx prisma migrate dev   # after setting DATABASE_URL");
+  if (options.drizzle) extraLines.push("npx drizzle-kit push    # after setting DB credentials");
+  if (options.redis)   extraLines.push("# Make sure Redis is running: redis-server");
+
+  printDivider();
+  printDoneMessage(appname, "npm run dev", extraLines);
+}

package/src/commands/createReact.js

@@ -0,0 +1,124 @@
+import path from "path";
+import fs from "fs-extra";
+import kleur from "kleur";
+import {
+  printStep,
+  printError,
+  printDivider,
+  runCommand,
+  printDoneMessage,
+} from "../utils.js";
+import {
+  reactAppJsx,
+  reactIndexCss,
+  reactViteConfig,
+  reactGitignore,
+  reactReadme,
+  reactEnv,
+  reactApiUtil,
+} from "../templates/react/index.js";
+
+export async function createReactProject(appname, options) {
+  const targetDir = path.resolve(process.cwd(), appname);
+
+  if (fs.existsSync(targetDir)) {
+    printError(`Folder "${appname}" already exists. Choose a different name.`);
+    process.exit(1);
+  }
+
+  console.log(
+    kleur.bold(`  Setting up React + Vite project: ${kleur.cyan(appname)}\n`)
+  );
+  printDivider();
+
+  printStep("Creating Vite + React app...");
+  await runCommand(
+    "npm",
+    ["create", "vite@latest", appname, "--", "--template", "react"],
+    process.cwd(),
+    "Running create-vite..."
+  );
+
+  printStep("Writing project files...");
+
+  const extraDirs = [
+    "src/components",
+    "src/pages",
+    "src/hooks",
+    "src/utils",
+    "src/assets",
+  ];
+  for (const dir of extraDirs) {
+    fs.mkdirSync(path.join(targetDir, dir), { recursive: true });
+    fs.writeFileSync(path.join(targetDir, dir, ".gitkeep"), "");
+  }
+
+  fs.writeFileSync(path.join(targetDir, "vite.config.js"), reactViteConfig());
+
+  fs.writeFileSync(
+    path.join(targetDir, "src/App.jsx"),
+    reactAppJsx(appname, options)
+  );
+  fs.writeFileSync(path.join(targetDir, "src/index.css"), reactIndexCss());
+
+  if (options.axios) {
+    fs.writeFileSync(
+      path.join(targetDir, "src/utils/api.js"),
+      reactApiUtil()
+    );
+  }
+
+  fs.writeFileSync(path.join(targetDir, ".env"), reactEnv());
+  fs.writeFileSync(path.join(targetDir, ".env.example"), reactEnv());
+  fs.writeFileSync(path.join(targetDir, ".gitignore"), reactGitignore());
+  fs.writeFileSync(
+    path.join(targetDir, "README.md"),
+    reactReadme(appname, options)
+  );
+
+  printDivider();
+
+  const coreDeps = [
+    "lucide-react",
+    "clsx",
+    "react-hot-toast",
+  ];
+
+  const devDeps = ["tailwindcss", "@tailwindcss/vite"];
+
+  if (options.router) coreDeps.push("react-router-dom");
+  if (options.axios) coreDeps.push("axios");
+
+  await runCommand("npm", ["install"], targetDir, "Installing base deps...");
+  await runCommand(
+    "npm",
+    ["install", ...coreDeps],
+    targetDir,
+    `Installing: ${coreDeps.join(", ")}`
+  );
+  await runCommand(
+    "npm",
+    ["install", "--save-dev", ...devDeps],
+    targetDir,
+    `Installing dev deps: ${devDeps.join(", ")}`
+  );
+
+  if (options.git !== false) {
+    printDivider();
+    await runCommand("git", ["init"], targetDir, "Initialising git repository...");
+    await runCommand("git", ["add", "."], targetDir, "Staging files...");
+    await runCommand(
+      "git",
+      ["commit", "-m", "chore: initial scaffold via devkit"],
+      targetDir,
+      "Initial commit..."
+    );
+  }
+
+  if (options.github) {
+    await runCommand("gh", ["repo", "create", appname, "--public", "--source=.", "--push"], targetDir, "Creating GitHub repo...");
+  }
+
+  printDivider();
+  printDoneMessage(appname, "npm run dev");
+}