deploy-bbc 1.1.0 → 1.2.1

package/.cspell.json

@@ -0,0 +1,38 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "words": [
+    "Aritra",
+    "Sarkar",
+    "aritra",
+    "bunx",
+    "hono",
+    "drizzle",
+    "bullmq",
+    "inngest",
+    "upstash",
+    "logtail",
+    "resend",
+    "sendgrid",
+    "nodemailer",
+    "socketio",
+    "vitest",
+    "postgres",
+    "mongodb",
+    "redis",
+    "Cloudflare",
+    "openai",
+    "anthropic",
+    "gemini",
+    "vercel",
+    "clack",
+    "natemoo"
+  ],
+  "ignorePaths": [
+    "node_modules",
+    "dist",
+    "build",
+    "*.min.js",
+    ".git"
+  ]
+}

package/CLAUDE.md

@@ -105,20 +105,86 @@ This document outlines the coding conventions and guidelines for the `create-bac
 
 ---
 
-## 📦 Type & Interface Naming
+## 📦 Type Naming & Usage
 
-### Use `PascalCase` for types, interfaces, enums, and classes
+### Use `PascalCase` for types, enums, and classes
 
 ```typescript
-✅ interface CliResults { }
+✅ type CliResults = { }
 ✅ type InstallerOptions = { }
 ✅ enum AvailablePackages { }
 ✅ class ProjectScaffold { }
 
-❌ interface cli_results { }
+❌ type cli_results = { }
 ❌ type installer_options = { }
 ```
 
+### ⚠️ ALWAYS use `type` instead of `interface`
+
+```typescript
+✅ type CliResults = {
+  appName: string;
+  flags: {
+    noGit: boolean;
+    noInstall: boolean;
+  };
+  packages: string[];
+}
+
+✅ type ScaffoldOptions = {
+  projectDir: string;
+  appName: string;
+  packages: string[];
+}
+
+❌ interface CliResults {
+  appName: string;
+  flags: {
+    noGit: boolean;
+    noInstall: boolean;
+  };
+  packages: string[];
+}
+
+❌ interface ScaffoldOptions {
+  projectDir: string;
+  appName: string;
+  packages: string[];
+}
+```
+
+**Why `type` over `interface`?**
+
+- **Consistency**: Single way to define object shapes
+- **Flexibility**: Types support unions, intersections, and mapped types more naturally
+- **Composability**: Better for complex type operations and transformations
+- **Simplicity**: One less concept to remember
+- **Modern practice**: Aligns with contemporary TypeScript patterns
+
+**Extending types:**
+
+```typescript
+✅ type BaseOptions = {
+  projectDir: string;
+  appName: string;
+}
+
+✅ type ExtendedOptions = BaseOptions & {
+  packages: string[];
+  flags: Record<string, boolean>;
+}
+
+❌ interface BaseOptions {
+  projectDir: string;
+  appName: string;
+}
+
+❌ interface ExtendedOptions extends BaseOptions {
+  packages: string[];
+  flags: Record<string, boolean>;
+}
+```
+
 ---
 
 ## 🗂️ Import/Export Conventions
@@ -163,7 +229,7 @@ import { install_dependencies } from "./install-dependencies.js";
 const DEFAULT_PROJECT_DIR = process.cwd();
 const TEMPLATE_BASE_PATH = "../templates/base";
 
-interface ScaffoldOptions {
+type ScaffoldOptions = {
   projectDir: string;
   appName: string;
   packages: string[];
@@ -247,7 +313,9 @@ To enforce these conventions, configure ESLint:
         "selector": "typeLike",
         "format": ["PascalCase"]
       }
-    ]
+    ],
+    "@typescript-eslint/consistent-type-definitions": ["error", "type"],
+    "@typescript-eslint/no-empty-interface": "error"
   }
 }
 ```
@@ -262,6 +330,7 @@ To enforce these conventions, configure ESLint:
 ❌ function createProject() { }  // camelCase function
 ❌ const project_dir = "";       // snake_case variable
 ❌ src/CreateProject.ts          // PascalCase file
+❌ interface CliResults { }      // Using interface
 ```
 
 ### ✅ Do stick to the rules
@@ -270,6 +339,7 @@ To enforce these conventions, configure ESLint:
 ✅ function create_project() { }  // snake_case function
 ✅ const projectDir = "";         // camelCase variable
 ✅ src/create-project.ts          // kebab-case file
+✅ type CliResults = { }          // Using type
 ```
 
 ---
@@ -283,9 +353,10 @@ To enforce these conventions, configure ESLint:
 | **Functions** | `snake_case` | `function create_project()` |
 | **Variables** | `camelCase` | `const projectDir` |
 | **Constants** | `SCREAMING_SNAKE_CASE` | `const MAX_RETRIES` |
-| **Types/Interfaces** | `PascalCase` | `interface CliResults` |
+| **Types** | `PascalCase` + `type` keyword | `type CliResults = { }` |
 | **Enums** | `PascalCase` | `enum AvailablePackages` |
 | **Classes** | `PascalCase` | `class ProjectScaffold` |
+| **Object Shapes** | Use `type`, NOT `interface` | `type Config = { }` |
 
 ---
 
@@ -294,10 +365,11 @@ To enforce these conventions, configure ESLint:
 When contributing to this project, please:
 
 1. ✅ Follow ALL conventions outlined in this document
-2. ✅ Run linting before committing: `bun run lint`
-3. ✅ Format code: `bun run format`
-4. ✅ Use descriptive commit messages
-5. ✅ Add JSDoc comments for exported functions
+2. ✅ Use `type` instead of `interface` for all object type definitions
+3. ✅ Run linting before committing: `bun run lint`
+4. ✅ Format code: `bun run format`
+5. ✅ Use descriptive commit messages
+6. ✅ Add JSDoc comments for exported functions
 
 ---
 
@@ -310,6 +382,7 @@ These conventions are chosen to:
 - **Reduce cognitive load** when working with multiple languages
 - **Follow industry standards** where applicable
 - **Enable better tooling support**
+- **Simplify type definitions** by using only `type` declarations
 
 ---
 
@@ -318,6 +391,7 @@ These conventions are chosen to:
 - [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript)
 - [TypeScript Style Guide](https://google.github.io/styleguide/tsguide.html)
 - [File Naming Conventions](https://github.com/kettanaito/naming-cheatsheet)
+- [Types vs Interfaces](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#differences-between-type-aliases-and-interfaces)
 
 ---
 

package/README.md

@@ -0,0 +1,358 @@
+# deploy-bbc
+
+> A powerful CLI tool to bootstrap production-ready backend applications with Bun
+
+## Overview
+
+`deploy-bbc` (Best Backend Code) is an interactive command-line tool that scaffolds modern, type-safe backend applications using Bun. It provides a comprehensive set of integrations for databases, authentication, AI services, cloud providers, and more - all configured and ready to use.
+
+## Features
+
+- **Three Framework Options**: Choose between Hono, Express, or Bun Native HTTP
+- **Production-Ready Templates**: Pre-configured with best practices and error handling
+- **30+ Integrations**: Databases, auth, AI, cloud storage, queues, and more
+- **Type-Safe**: Full TypeScript support with strict typing
+- **Docker Ready**: Automatic Dockerfile and docker-compose generation
+- **Developer Experience**: Built-in validation, testing, and API documentation options
+- **Zero Config**: Works out of the box with sensible defaults
+
+## Quick Start
+
+```bash
+# Using npx (recommended)
+npx deploy-bbc my-backend
+
+# Using bun
+bunx deploy-bbc my-backend
+
+# Using npm
+npm create backend-app my-backend
+```
+
+Follow the interactive prompts to select your framework and integrations.
+
+## Installation
+
+### As a CLI Tool
+
+```bash
+# Install globally
+npm install -g deploy-bbc
+
+# Run
+deploy-bbc my-app-name
+```
+
+### From Source
+
+```bash
+# Clone the repository
+git clone https://github.com/aritra69/deploy-bbc.git
+cd deploy-bbc
+
+# Install dependencies
+bun install
+
+# Build
+bun run build
+
+# Link for local development
+npm link
+```
+
+## Usage
+
+### Interactive Mode
+
+Simply run the CLI and answer the prompts:
+
+```bash
+deploy-bbc my-backend
+```
+
+You'll be prompted to:
+
+1. Choose a framework (Hono, Express, or Bun Native)
+2. Select integrations (databases, auth, AI services, etc.)
+3. Configure additional options
+
+### CLI Flags
+
+```bash
+deploy-bbc my-backend [options]
+```
+
+#### General Options
+
+- `--no-git` - Skip Git initialization
+- `--no-install` - Skip dependency installation
+- `--default` - Use default configuration (Hono with no extras)
+- `--CI` - Run in CI mode (non-interactive)
+
+#### Database Options
+
+- `--postgres` - Add PostgreSQL with Drizzle ORM
+- `--mysql` - Add MySQL with Drizzle ORM
+- `--mongodb` - Add MongoDB with Mongoose
+- `--redis` - Add Redis support
+
+#### Authentication Options
+
+- `--jwt` - Add JWT authentication
+- `--oauth` - Add OAuth 2.0 support
+- `--session` - Add session-based authentication
+
+#### AI Integration Options
+
+- `--openai` - Add OpenAI integration
+- `--anthropic` - Add Anthropic Claude integration
+- `--gemini` - Add Google Gemini integration
+- `--vercel-ai` - Add Vercel AI SDK
+
+#### Cloud Provider Options
+
+- `--aws` - Add AWS SDK (S3, SES)
+- `--gcp` - Add Google Cloud Platform SDK
+- `--azure` - Add Azure SDK
+- `--cloudflare-r2` - Add Cloudflare R2 storage
+
+#### Communication Options
+
+- `--resend` - Add Resend email service
+- `--sendgrid` - Add SendGrid email service
+- `--nodemailer` - Add Nodemailer
+- `--socketio` - Add Socket.IO for WebSockets
+- `--sse` - Add Server-Sent Events
+
+#### Infrastructure Options
+
+- `--bullmq` - Add BullMQ job queue
+- `--inngest` - Add Inngest workflow engine
+- `--upstash-ratelimit` - Add Upstash rate limiting
+- `--custom-ratelimit` - Add custom rate limiting
+- `--sentry` - Add Sentry error tracking
+- `--logtail` - Add Logtail logging
+
+#### Developer Experience Options
+
+- `--swagger` - Add Swagger/OpenAPI documentation
+- `--scalar` - Add Scalar API documentation
+- `--vitest` - Add Vitest testing framework
+- `--zod` - Add Zod validation
+- `--yup` - Add Yup validation
+
+### Example Commands
+
+```bash
+# Create a Hono app with PostgreSQL and JWT auth
+deploy-bbc my-api --postgres --jwt
+
+# Create an Express app with full stack
+deploy-bbc my-app --postgres --redis --jwt --openai --aws --swagger
+
+# Create a minimal Bun native app
+deploy-bbc my-api --default
+
+# Create without Git initialization
+deploy-bbc my-api --no-git --postgres --jwt
+```
+
+## Framework Options
+
+### Hono (Default)
+
+Ultra-fast web framework optimized for Bun and edge runtimes. Lightweight and type-safe.
+
+### Express
+
+Battle-tested Node.js framework with extensive ecosystem and middleware support.
+
+### Bun Native HTTP
+
+Use Bun's native HTTP server for maximum performance with minimal overhead.
+
+## Available Integrations
+
+### Databases
+
+- **PostgreSQL** - Relational database with Drizzle ORM
+- **MySQL** - Relational database with Drizzle ORM
+- **MongoDB** - Document database with Mongoose ODM
+- **Redis** - In-memory data store for caching and sessions
+
+### Authentication
+
+- **JWT** - JSON Web Token authentication with utilities
+- **OAuth 2.0** - Third-party authentication (Google, GitHub, etc.)
+- **Session** - Traditional session-based authentication
+
+### AI & Machine Learning
+
+- **OpenAI** - GPT models integration
+- **Anthropic** - Claude AI integration
+- **Google Gemini** - Gemini AI models
+- **Vercel AI SDK** - Multi-provider AI SDK with streaming support
+
+### Cloud & Storage
+
+- **AWS** - S3 storage, SES email, and more
+- **Google Cloud Platform** - Cloud Storage and services
+- **Azure** - Blob storage and Azure services
+- **Cloudflare R2** - S3-compatible object storage
+
+### Communication
+
+- **Resend** - Modern transactional email
+- **SendGrid** - Email delivery service
+- **Nodemailer** - Flexible email sending
+- **Socket.IO** - Real-time bidirectional communication
+- **Server-Sent Events** - Server-to-client streaming
+
+### Infrastructure
+
+- **BullMQ** - Redis-based job queue
+- **Inngest** - Durable workflow engine
+- **Rate Limiting** - Upstash or custom implementation
+- **Sentry** - Error tracking and monitoring
+- **Logtail** - Log management and analytics
+
+### Developer Experience
+
+- **Swagger/OpenAPI** - Interactive API documentation
+- **Scalar** - Beautiful API documentation
+- **Vitest** - Fast unit testing framework
+- **Zod** - TypeScript-first schema validation
+- **Yup** - Object schema validation
+
+## Project Structure
+
+```plaintext
+my-backend/
+├── src/
+│   ├── config/          # Configuration files
+│   ├── middleware/      # Express/Hono middleware
+│   ├── routes/          # API routes
+│   ├── services/        # Business logic
+│   ├── db/              # Database configuration
+│   ├── utils/           # Utility functions
+│   ├── types/           # TypeScript types
+│   └── index.ts         # Application entry point
+├── .env.example         # Environment variables template
+├── .gitignore
+├── package.json
+├── tsconfig.json
+├── Dockerfile           # Docker configuration
+├── docker-compose.yml   # Docker Compose setup
+└── README.md
+```
+
+## Development
+
+### Prerequisites
+
+- Node.js >= 18.0.0
+- Bun >= 1.0.0 (recommended)
+
+### Commands
+
+```bash
+# Development mode with hot reload
+bun run dev
+
+# Build the project
+bun run build
+
+# Type checking
+bun run type-check
+
+# Lint code
+bun run lint
+
+# Format code
+bun run format
+```
+
+### Contributing
+
+We welcome contributions! Please follow these steps:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Follow the coding conventions in `CLAUDE.md`
+4. Commit your changes (`git commit -m 'Add amazing feature'`)
+5. Push to the branch (`git push origin feature/amazing-feature`)
+6. Open a Pull Request
+
+#### Coding Conventions
+
+This project follows specific naming conventions:
+
+- **Files/Folders**: `kebab-case`
+- **Functions**: `snake_case`
+- **Variables**: `snake_case`
+- **Types**: `PascalCase` (use `type`, not `interface`)
+- **Constants**: `SCREAMING_SNAKE_CASE`
+
+See `CLAUDE.md` for complete guidelines.
+
+## Docker Support
+
+Every generated project includes Docker configuration:
+
+```bash
+# Build and run with Docker Compose
+docker-compose up
+
+# Build Docker image
+docker build -t my-backend .
+
+# Run container
+docker run -p 8000:8000 my-backend
+```
+
+## Environment Variables
+
+Each integration adds its required environment variables to `.env.example`. Copy it to `.env` and fill in your values:
+
+```bash
+cp .env.example .env
+```
+
+## License
+
+MIT License - see LICENSE file for details
+
+## Author
+
+### Aritra Sarkar
+
+- GitHub: [@aritra69](https://github.com/aritra69)
+- Email: <aritrasarkar2002@gmail.com>
+
+## Contributors
+
+This project exists thanks to all the people who contribute.
+
+[![Contributors](https://contrib.rocks/image?repo=aritra69/deploy-bbc)](https://github.com/aritra69/deploy-bbc/graphs/contributors)
+
+### How to Contribute
+
+We appreciate all contributions! See the [Contributing](#contributing) section above for guidelines.
+
+## Support
+
+- Issues: [GitHub Issues](https://github.com/aritra69/deploy-bbc/issues)
+- Discussions: [GitHub Discussions](https://github.com/aritra69/deploy-bbc/discussions)
+
+## Acknowledgments
+
+Built with:
+
+- [Bun](https://bun.sh) - Fast all-in-one JavaScript runtime
+- [Hono](https://hono.dev) - Ultra-fast web framework
+- [Drizzle ORM](https://orm.drizzle.team) - TypeScript ORM
+- [Clack](https://github.com/natemoo-re/clack) - Interactive CLI prompts
+
+---
+
+**Star this repository if you find it helpful!**

package/cli/package.json

@@ -1,6 +1,6 @@
 {
     "name": "deploy-bbc",
-    "version": "1.1.0",
+    "version": "1.2.1",
     "description": "CLI to bootstrap production-ready backends with Bun (Best Backend Code)",
     "type": "module",
     "bin": {
@@ -38,17 +38,17 @@
         "url": "https://github.com/aritra69/deploy-bbc/issues"
     },
     "dependencies": {
-        "@clack/prompts": "^0.7.0",
-        "chalk": "^5.3.0",
-        "commander": "^11.1.0",
-        "execa": "^8.0.1",
-        "fs-extra": "^11.2.0",
-        "ora": "^7.0.1"
+        "@clack/prompts": "^0.11.0",
+        "chalk": "^5.6.2",
+        "commander": "^14.0.2",
+        "execa": "^9.6.1",
+        "fs-extra": "^11.3.3",
+        "ora": "^9.1.0"
     },
     "devDependencies": {
         "@types/bun": "latest",
         "@types/fs-extra": "^11.0.4",
-        "@types/node": "^20.10.6",
-        "typescript": "^5.3.3"
+        "@types/node": "^25.0.10",
+        "typescript": "^5.9.3"
     }
 }

package/cli/src/cli/index.ts

@@ -100,12 +100,17 @@ export const run_cli = async (): Promise<CliResults> => {
       projectName: () =>
         p.text({
           message: "What will your project be called?",
-          placeholder: "my-awesome-api",
+          placeholder: "my-awesome-api (or . for current directory)",
           defaultValue: cliProvidedName || "my-backend",
           validate: (value) => {
             if (!value) return "Please enter a project name";
-            if (!/^[a-z0-9-_]+$/i.test(value))
-              return "Only letters, numbers, dashes and underscores";
+            // Allow '.' for current directory or paths
+            if (value === "." || value.startsWith("./") || value.startsWith("../") || value.startsWith("~/")) {
+              return; // Valid path
+            }
+            // Otherwise check for valid name format
+            if (!/^[a-z0-9-_/]+$/i.test(value))
+              return "Only letters, numbers, dashes, underscores, and slashes";
           },
         }),
 

package/cli/src/helpers/generate-docker-compose.ts

@@ -33,7 +33,7 @@ services:
   composeContent += `  app:
     build: .
     ports:
-      - "3000:3000"
+      - "8000:8000"
     environment:
       - NODE_ENV=production
     env_file:

package/cli/src/helpers/generate-dockerfile.ts

@@ -34,7 +34,7 @@ COPY --from=dependencies /app/node_modules ./node_modules
 COPY --from=build /app .
 
 # Expose port
-EXPOSE 3000
+EXPOSE 8000
 
 # Run the application
 CMD ["bun", "run", "src/index.ts"]