backend-starter-kit 1.0.5

package/bin/cli.js

@@ -0,0 +1,105 @@
+#!/usr/bin/env node
+import { execSync } from "child_process";
+import { existsSync, mkdirSync, cpSync } from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+import ora from "ora";
+import chalk from "chalk";
+import prompts from "prompts";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+function runCommand(command, options = {}) {
+  try {
+    return execSync(command, {
+      stdio: "pipe",
+      encoding: "utf-8",
+      ...options,
+    }).trim();
+  } catch {
+    return null;
+  }
+}
+
+async function main() {
+  let projectName = process.argv[2];
+  if (!projectName) {
+    const response = await prompts({
+      type: "text",
+      name: "projectName",
+      message: "What is your project named?",
+      initial: "my-app",
+    });
+    projectName = response.projectName;
+  }
+
+  const projectPath = path.resolve(process.cwd(), projectName);
+  if (projectName !== "." && existsSync(projectPath)) {
+    console.error(chalk.red(`❌ Folder "${projectName}" already exists.`));
+    process.exit(1);
+  }
+
+  const { packageManager } = await prompts({
+    type: "select",
+    name: "packageManager",
+    message: "Which package manager would you like to use?",
+    choices: [
+      { title: "pnpm (recommended)", value: "pnpm" },
+      { title: "npm", value: "npm" },
+      { title: "yarn", value: "yarn" },
+      { title: "bun", value: "bun" },
+    ],
+    initial: 0,
+  });
+
+  console.log(`\nCreating a new Backend app in ${chalk.cyan(projectPath)}.\n`);
+  console.log(`Using ${chalk.cyan(packageManager)}.\n`);
+  console.log(`Initializing project with template: backend\n`);
+
+  if (projectName !== ".") mkdirSync(projectPath);
+  const templateDir = path.join(__dirname, "../template");
+  cpSync(templateDir, projectPath, { recursive: true });
+
+  const spinner = ora("Initializing git repository...").start();
+  runCommand("git init", { cwd: projectPath });
+  spinner.stop();
+  console.log(chalk.green("Initialized a git repository.\n"));
+
+  console.log(chalk.cyan(`Installing dependencies...\n`));
+  try {
+    if (packageManager === "npm")
+      runCommand("npm install", { cwd: projectPath });
+    else if (packageManager === "pnpm")
+      runCommand("pnpm install", { cwd: projectPath });
+    else if (packageManager === "yarn")
+      runCommand("yarn install", { cwd: projectPath });
+    else if (packageManager === "bun")
+      runCommand("bun install", { cwd: projectPath });
+  } catch {
+    console.log(
+      chalk.yellow("\n⚠ Warning: Some build scripts were ignored.\n"),
+    );
+  }
+  console.log(
+    chalk.green(
+      `Done in ${chalk.cyan("~10s")} using ${chalk.cyan(packageManager)}.`,
+    ),
+  );
+  console.log(
+    chalk.green(
+      `\n✅ Success! Created ${projectName} at ${chalk.cyan(projectPath)}`,
+    ),
+  );
+  console.log(chalk.cyan(`\nNext steps:`));
+  console.log(chalk.cyan(`  1. cd ${projectName}`));
+  console.log(chalk.cyan(`  2. Update .env with your database credentials`));
+  console.log(
+    chalk.cyan(
+      `  3. Run ${packageManager} run dev to start the backend server`,
+    ),
+  );
+  console.log(chalk.cyan(`  4. Access API docs at /api/v1/docs`));
+}
+
+main();

package/package.json

@@ -0,0 +1,44 @@
+{
+    "name": "backend-starter-kit",
+    "version": "1.0.5",
+    "bin": {
+        "create-backend-starter": "bin/cli.js"
+    },
+    "keywords": [
+        "backend",
+        "bunjs",
+        "express"
+    ],
+    "description": "Create backend-powered applications with one command",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/harshit-ostwal/backend-starter-kit.git"
+    },
+    "homepage": "https://github.com/harshit-ostwal/backend-starter-kit.git",
+    "author": "Harshit Ostwal <codewithharshitjain@gmail.com>",
+    "type": "module",
+    "bugs": {
+        "url": "https://github.com/harshit-ostwal/backend-starter-kit.git/issues"
+    },
+    "license": "MIT",
+    "files": [
+        "bin",
+        "template"
+    ],
+    "dependencies": {
+        "chalk": "^5.6.0",
+        "commander": "^14.0.0",
+        "ora": "^8.2.0",
+        "prompts": "^2.4.2",
+        "readline": "^1.3.0"
+    },
+    "engines": {
+        "bun": ">=1.3.4"
+    },
+    "nextBundleAnalysis": {
+        "budget": 358400,
+        "budgetPercentIncreaseRed": 20,
+        "minimumChangeThreshold": 0,
+        "showDetails": true
+    }
+}

package/template/.biomeignore

@@ -0,0 +1,40 @@
+# Dependencies
+node_modules
+
+# Output directories
+dist
+build
+out
+coverage
+*.tgz
+.next
+.nuxt
+.output
+.vercel
+.netlify
+
+# Logs
+logs
+*.log
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Environment files
+.env
+.env.*
+!.env.example
+!.env.ci
+
+# Generated files
+/src/generated/prisma
+prisma/migrations
+
+# System files
+.DS_Store
+
+# Cache files
+.cache
+.eslintcache
+*.tsbuildinfo
+
+# IDE
+.idea

package/template/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+## 📌 What’s changing?
+
+<!-- Briefly explain what this PR does -->
+
+## ✅ Checklist
+
+- [ ] I tested this change locally
+- [ ] I updated related docs (if needed)
+- [ ] This PR is rebased on the latest base branch
+- [ ] This PR is ready to squash & merge
+
+## 🚀 Deployment notes
+
+<!-- Optional: Add notes if anything special is needed during deploy -->
+
+## 🎯 Related Issues or Cards
+
+Closes #

package/template/.github/workflows/check.yml

@@ -0,0 +1,107 @@
+name: PR Check
+
+on:
+  pull_request:
+    branches:
+      - dev
+      - test
+      - prod
+
+  push:
+    branches:
+      - dev
+      - test
+      - prod
+
+jobs:
+  lint-and-build:
+    runs-on: ubuntu-latest
+    env:
+      NODE_ENV: development
+      PORT: "8080"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Use Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Enable Corepack & Install
+        run: |
+          corepack enable
+          bun install --frozen-lockfile
+
+      - name: Check Formatting
+        run: bunx biome check --write
+
+      - name: Lint Code
+        run: bunx biome lint --write
+
+      - name: Formatting Code
+        run: bunx biome format --write
+
+  test:
+    runs-on: ubuntu-latest
+    needs: lint-and-build
+    env:
+      NODE_ENV: development
+      PORT: "8080"
+      DATABASE_URL: "postgresql://postgres:password@localhost:5432/mydb?schema=public"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Use Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Install Dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Prisma Generate
+        run: bunx prisma generate
+
+      - name: Start Server in Background
+        run: |
+          # start the server in background and redirect logs to server.log
+          nohup bun start > server.log 2>&1 &
+
+          # Print a quick message and show the last few lines to help debugging
+          echo "Server started in background (check server.log)."
+          sleep 1
+          tail -n 20 server.log || true
+
+      - name: Wait for service to become healthy
+        run: |
+          set -euo pipefail
+          URL="http://localhost:${PORT:-8080}/api/v1/health"
+          ATTEMPTS=30
+          SLEEP_SECS=2
+
+          echo "Waiting for service to become healthy at: $URL"
+          i=0
+          until [ $i -ge $ATTEMPTS ]; do
+            if curl -fsS "$URL" >/dev/null 2>&1; then
+              echo "Service is healthy."
+              exit 0
+            fi
+            i=$((i+1))
+            echo "Waiting... ($i/$ATTEMPTS)"
+            sleep "$SLEEP_SECS"
+          done
+
+          echo "Service did not become healthy after $ATTEMPTS attempts."
+          echo "====== Last 200 lines of server.log ======"
+          tail -n 200 server.log || true
+          echo "=========================================="
+          exit 1
+
+      - name: Call Health Check API (final verify)
+        run: |
+          echo "Final health-check..."
+          curl -f http://localhost:${PORT}/api/v1/health

package/template/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+bunx lint-staged

package/template/README.md

@@ -0,0 +1,66 @@
+# Backend Starter Template
+
+Production-ready backend using Bun, Express, Prisma, and more.
+
+## Features
+- Bun runtime for fast performance
+- Express.js for routing and middleware
+- Prisma ORM for PostgreSQL
+- Zod for validation
+- Swagger UI for API docs
+- Winston for logging
+- Helmet, CORS, cookie-parser, JWT, and more for security
+- Ready-to-use project structure
+- Biome for formatting and linting
+
+## Getting Started
+
+### 1. Create a new project
+```sh
+bunx backend-starter <your-project-name>
+```
+
+### 2. Install dependencies
+```sh
+cd <your-project-name>
+# Use your chosen package manager
+bun install
+```
+
+### 3. Configure environment variables
+Edit `.env` with your database credentials and other settings.
+
+### 4. Run the development server
+```sh
+bun run dev
+```
+
+### 5. Access API documentation
+Visit `http://localhost:8080/api/v1/docs` for Swagger UI.
+
+## Scripts
+- `dev`: Start server with hot reload
+- `start`: Start server
+- `biome:*`: Format, lint, check, clean code
+- `prisma:*`: Prisma ORM commands
+
+## Project Structure
+```
+├── src/
+│   ├── app.js
+│   ├── index.js
+│   ├── config/
+│   ├── constants/
+│   ├── core/
+│   ├── routes/
+├── prisma/
+│   └── schema.prisma
+├── .env
+├── package.json
+```
+
+## License
+MIT
+
+---
+Made by Harshit Ostwal

package/template/biome.json

@@ -0,0 +1,65 @@
+{
+    "$schema": "https://biomejs.dev/schemas/2.3.13/schema.json",
+    "vcs": {
+        "enabled": false,
+        "clientKind": "git",
+        "useIgnoreFile": false
+    },
+    "files": {
+        "ignoreUnknown": false
+    },
+    "formatter": {
+        "enabled": true,
+        "formatWithErrors": false,
+        "indentStyle": "space",
+        "indentWidth": 4,
+        "lineEnding": "lf",
+        "lineWidth": 80,
+        "attributePosition": "auto",
+        "bracketSameLine": false,
+        "bracketSpacing": true,
+        "expand": "auto",
+        "useEditorconfig": true
+    },
+    "linter": {
+        "enabled": true,
+        "rules": {
+            "recommended": false,
+            "correctness": {
+                "noUnusedVariables": "warn"
+            },
+            "suspicious": {
+                "noConsole": "warn"
+            }
+        },
+        "includes": ["**/*.{js,cjs,mjs}"]
+    },
+    "javascript": {
+        "formatter": {
+            "jsxQuoteStyle": "double",
+            "quoteProperties": "asNeeded",
+            "trailingCommas": "es5",
+            "semicolons": "always",
+            "arrowParentheses": "always",
+            "bracketSameLine": false,
+            "quoteStyle": "double",
+            "attributePosition": "auto",
+            "bracketSpacing": true
+        },
+        "globals": ["exports"]
+    },
+    "html": {
+        "formatter": {
+            "indentScriptAndStyle": false,
+            "selfCloseVoidElements": "always"
+        }
+    },
+    "assist": {
+        "enabled": true,
+        "actions": {
+            "source": {
+                "organizeImports": "on"
+            }
+        }
+    }
+}