richmond-next-orbit-kernel 1.0.1

package/README.md

@@ -0,0 +1,152 @@
+# better-auth-kit 🔐 by Watuulo-Richard
+
+> A CLI that scaffolds a production-ready Next.js + TypeScript project with **Better Auth** pre-configured in seconds.
+
+---
+
+## 📦 Installation
+
+You can use it directly without installing:
+
+```bash
+npx better-auth-kit <project-name>
+```
+
+Or install it globally:
+
+```bash
+npm install -g better-auth-kit
+better-auth-kit <project-name>
+```
+
+---
+
+## 🚀 Quick Start
+
+```bash
+npx better-auth-kit my-app
+cd my-app
+npm install
+npm dev
+```
+
+That's it. Your project is scaffolded and ready to go.
+
+---
+
+## ✨ What You Get
+
+Every project scaffolded with `better-auth-kit` comes with:
+
+- 🔐 **Better Auth** — credentials & Google OAuth pre-configured
+- 🟦 **TypeScript** — fully typed from day one
+- ⚡ **Next.js 15** — App Router, Server Actions, the works
+- 🗄️ **Prisma + PostgreSQL** — schema and migrations ready to run
+- 🎨 **Tailwind CSS + ShadCN UI** — clean, accessible component library
+- 📁 **Sensible project structure** — no clutter, no guesswork
+
+---
+
+## 🖥️ CLI Usage
+
+```bash
+better-auth-kit <project-name>
+```
+
+### Arguments
+
+| Argument | Description |
+|---|---|
+| `<project-name>` | The name of the project to scaffold |
+
+### Example
+
+```bash
+npx better-auth-kit my-saas-app
+```
+
+This will:
+1. Clone the TypeScript starter template
+2. Rename the project
+3. Install all dependencies
+4. Print next steps
+
+---
+
+## ⚙️ After Scaffolding
+
+### 1. Set Up Environment Variables
+
+Create a `.env` file in your project root:
+
+```env
+# Better Auth
+BETTER_AUTH_SECRET=<your_better_auth_secret>
+BETTER_AUTH_URL=http://localhost:3000
+
+# PostgreSQL
+DATABASE_URL="postgresql://<username>:<password>@<host>/<database_name>?sslmode=require"
+
+# Google OAuth
+GOOGLE_CLIENT_ID=<your_google_client_id>
+GOOGLE_CLIENT_SECRET=<your_google_client_secret>
+```
+
+> 💡 Generate a secure secret with: `openssl rand -base64 32`
+
+### 2. Run Database Migrations
+
+```bash
+npx prisma migrate dev
+```
+
+### 3. Start the Dev Server
+
+```bash
+npm dev
+```
+
+App runs at **http://localhost:3000**.
+
+---
+
+## 📁 Scaffolded Project Structure
+
+```
+my-app/
+├── app/
+│   ├── (auth)/           # Login & register pages
+│   ├── (dashboard)/      # Protected routes
+│   └── api/auth/         # Better Auth API route
+├── components/           # ShadCN UI components
+├── lib/
+│   └── auth.ts           # Better Auth config
+├── prisma/
+│   └── schema.prisma     # Database schema
+├── .env                  # Environment variables
+└── package.json
+```
+
+---
+
+## 🔗 Live Demo
+
+See the scaffolded template live: [better-auth-kit.vercel.app](https://next-shield.vercel.app/)
+
+---
+
+## 🤝 Contributing
+
+Contributions, issues, and feature requests are welcome!
+
+1. Fork the repository
+2. Create your branch: `git checkout -b feature/my-feature`
+3. Commit your changes: `git commit -m 'add my feature'`
+4. Push to the branch: `git push origin feature/my-feature`
+5. Open a pull request
+
+---
+
+## 📄 License
+
+MIT © [Watuulo Richard](https://github.com/Watuulo-Richard)

package/index.js

@@ -0,0 +1,109 @@
+#!/usr/bin/env node
+
+import { Command } from "commander";
+import chalk from "chalk";
+import fs from "fs-extra";
+import path from "path";
+import { simpleGit } from "simple-git";
+import ora from "ora";
+import inquirer from "inquirer";
+import { execSync } from "child_process";
+
+// ASCII art shown first when command runs
+console.log(
+  chalk.cyan(`
+  ██████╗ ███████╗████████╗████████╗███████╗██████╗       █████╗ ██╗   ██╗████████╗██╗  ██╗
+  ██╔══██╗██╔════╝╚══██╔══╝╚══██╔══╝██╔════╝██╔══██╗     ██╔══██╗██║   ██║╚══██╔══╝██║  ██║
+  ██████╔╝█████╗     ██║      ██║   █████╗  ██████╔╝     ███████║██║   ██║   ██║   ███████║
+  ██╔══██╗██╔══╝     ██║      ██║   ██╔══╝  ██╔══██╗     ██╔══██║██║   ██║   ██║   ██╔══██║
+  ██████╔╝███████╗   ██║      ██║   ███████╗██║  ██║     ██║  ██║╚██████╔╝   ██║   ██║  ██║
+  ╚═════╝ ╚══════╝   ╚═╝      ╚═╝   ╚══════╝╚═╝  ╚═╝     ╚═╝  ╚═╝ ╚═════╝    ╚═╝   ╚═╝  ╚═╝
+  `),
+);
+
+console.log(chalk.cyan("  PACKAGE\n"));
+console.log(chalk.gray("  Modern Authentication Starter for Next.js\n"));
+
+const program = new Command();
+
+program
+  .version("1.0.0")
+  .argument("<project-name>", "name of the project")
+  .action(async (projectName) => {
+    // The main logic of your CLI will go here
+    // Check if the project name already exists
+    // Choose the next-js template
+    // Clone the next-js template
+    // While downloading show the spinner
+    // While downloading show the spinner
+    // When the download is complete, show a message
+    // Create the project name
+    // Cd into the project and install the dependencies
+    // After we display a message
+    const projectPath = path.join(process.cwd(), projectName);
+
+    // Check if the project directory already exists
+    if (fs.existsSync(projectPath)) {
+      console.error(
+        chalk.red(`Error: Directory ${projectName} already exists.`),
+      );
+      process.exit(1);
+    }
+
+    // Prompt the user to select the template type
+    const answers = await inquirer.prompt([
+      {
+        type: "confirm",
+        name: "useTypeScript",
+        message: "Use TypeScript? (recommended)",
+        default: true,
+      },
+    ]);
+
+    // Determine the repository URL based on the user's selection
+    const repoUrl =
+      "https://github.com/Watuulo-Richard/Better-Auth-Modern-Authentication-Lesson-Next.js-TypeScript-.git";
+
+    // Create the project directory
+    fs.mkdirSync(projectPath);
+
+    // Set up the spinner for visual feedback
+    const spinner = ora({
+      text: "Downloading TypeScript template by Watuulo-Richard...",
+      spinner: {
+        interval: 80,
+        frames: ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"],
+      },
+      color: "yellow",
+    }).start();
+
+    const git = simpleGit();
+
+    try {
+      // Clone the selected template
+      await git.clone(repoUrl, projectPath);
+      spinner.succeed("TypeScript template downloaded successfully!");
+
+      // Navigate into the project directory
+      process.chdir(projectPath);
+
+      // Stop spinner BEFORE running npm install (stdio: inherit takes over the terminal)
+      console.log(chalk.yellow("Installing dependencies..."));
+
+      execSync("npm install --ignore-scripts", { stdio: "inherit" });
+
+      console.log(chalk.green("✔ Dependencies installed successfully!"));
+      console.log(chalk.green(`\nProject ${projectName} is ready!`));
+      console.log(chalk.cyan(`  cd ${projectName}`));
+      console.log(
+        chalk.cyan(`  # Add DATABASE_URL to your .env file first, then:`),
+      );
+      console.log(chalk.cyan(`  npm run dev`));
+    } catch (error) {
+      spinner.fail("Failed to set up the project.");
+      console.error(chalk.red(error.message));
+      process.exit(1);
+    }
+  });
+
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "richmond-next-orbit-kernel",
+  "version": "1.0.1",
+  "description": "A toolkit of utilities, plugins, and helpers built on top of better-auth for faster and easier authentication integration.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "bin": {
+    "richmond-next-orbit-kernel": "index.js"
+  },
+  "keywords": [
+    "better-auth",
+    "auth",
+    "authentication",
+    "toolkit",
+    "plugins",
+    "helpers",
+    "typescript"
+  ],
+  "author": "watuulo richard",
+  "license": "MIT",
+  "type": "module",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.3",
+    "figlet": "^1.10.0",
+    "fs-extra": "^11.3.3",
+    "inquirer": "^13.2.5",
+    "ora": "^9.3.0",
+    "simple-git": "^3.31.1"
+  },
+  "devDependencies": {
+    "@types/figlet": "^1.7.0"
+  }
+}