deploy-bbc 1.2.1 → 1.2.2

package/README.md

@@ -1,358 +1,345 @@
-# deploy-bbc
+# 🚀 deploy-bbc (Best Backend Code)
 
-> A powerful CLI tool to bootstrap production-ready backend applications with Bun
+Bootstrap production-ready backend projects with Bun, TypeScript, and Docker in seconds.
 
-## Overview
+[![npm version](https://img.shields.io/npm/v/deploy-bbc.svg)](https://www.npmjs.com/package/deploy-bbc)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-`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
 
-## Features
+- 🎯 **Interactive CLI** - Step-by-step project setup with beautiful prompts
+- ⚡ **3 Framework Options** - Choose between Hono, Express, or Bun Native
+- 🗄️ **Multiple Databases** - PostgreSQL, MySQL, MongoDB, Redis with Drizzle ORM/Mongoose
+- 🔐 **Authentication** - JWT, OAuth 2.0, Session-based auth
+- 🤖 **AI Integration** - OpenAI, Anthropic Claude, Google Gemini, Vercel AI SDK
+- ☁️ **Cloud Storage** - AWS S3, Google Cloud, Azure, Cloudflare R2
+- 📧 **Email Services** - Resend, SendGrid, NodeMailer
+- 🔄 **Real-time** - Socket.io, Server-Sent Events
+- 📝 **Validation** - Zod or Yup for request validation
+- 📊 **Background Jobs** - BullMQ, Inngest
+- 📚 **API Documentation** - Swagger/OpenAPI, Scalar
+- 🧪 **Testing** - Vitest with Supertest
+- 🐳 **Docker Ready** - Dockerfile + docker-compose.yml included
+- 📦 **TypeScript** - Full type safety out of the box
 
-- **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
+## 🚀 Quick Start
 
 ```bash
 # Using npx (recommended)
-npx deploy-bbc my-backend
-
-# Using bun
-bunx deploy-bbc my-backend
+npx deploy-bbc my-awesome-api
 
 # Using npm
-npm create backend-app my-backend
-```
-
-Follow the interactive prompts to select your framework and integrations.
+npm create deploy-bbc my-awesome-api
 
-## Installation
+# Using bun
+bunx deploy-bbc my-awesome-api
+```
 
-### As a CLI Tool
+## 📦 Installation
 
 ```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
+# Use directly with npx
+npx deploy-bbc
 ```
 
-## Usage
+## 🎨 Usage
 
 ### Interactive Mode
 
-Simply run the CLI and answer the prompts:
+Simply run the command and follow the prompts:
 
 ```bash
-deploy-bbc my-backend
+npx deploy-bbc my-project
 ```
 
-You'll be prompted to:
+You'll be asked to select:
+1. **Project name** - Your application name
+2. **Framework** - Hono (recommended), Express, or Bun Native
+3. **Database(s)** - PostgreSQL, MySQL, MongoDB, Redis
+4. **Authentication** - JWT, OAuth, Session-based
+5. **AI Providers** - OpenAI, Anthropic, Gemini
+6. **Email Service** - Resend, SendGrid, NodeMailer
+7. **Real-time** - Socket.io or SSE
+8. **Background Jobs** - BullMQ or Inngest
+9. **Validation** - Zod or Yup
+10. **API Docs** - Swagger or Scalar
+11. **Testing** - Vitest setup
 
-1. Choose a framework (Hono, Express, or Bun Native)
-2. Select integrations (databases, auth, AI services, etc.)
-3. Configure additional options
+### CI Mode (Non-Interactive)
 
-### CLI Flags
+Perfect for automated deployments:
 
 ```bash
-deploy-bbc my-backend [options]
+npx deploy-bbc my-project \
+  --CI \
+  --express \
+  --postgres \
+  --redis \
+  --jwt \
+  --zod \
+  --vitest \
+  --swagger \
+  --noGit
 ```
 
-#### 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
+## 🛠️ Framework Options
 
+### Hono (Default)
 ```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
+npx deploy-bbc my-app --hono
 ```
-
-## Framework Options
-
-### Hono (Default)
-
-Ultra-fast web framework optimized for Bun and edge runtimes. Lightweight and type-safe.
+- Ultrafast web framework built for the edge
+- Tiny footprint (~12KB)
+- Express-like API
+- **Recommended for most projects**
 
 ### Express
+```bash
+npx deploy-bbc my-app --express
+```
+- Battle-tested Node.js framework
+- Huge ecosystem
+- Familiar to most developers
 
-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.
+### Bun Native
+```bash
+npx deploy-bbc my-app --bun-native
+```
+- Native Bun.serve() API
+- Zero dependencies
+- Maximum performance
 
-## Available Integrations
+## 📊 Available Packages
 
 ### 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
+- `--postgres` - PostgreSQL with Drizzle ORM
+- `--mysql` - MySQL with Drizzle ORM
+- `--mongodb` - MongoDB with Mongoose
+- `--redis` - Redis for caching & 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
+- `--jwt` - JSON Web Token authentication
+- `--oauth` - OAuth 2.0 (Google, GitHub)
+- `--session` - Session-based auth (requires Redis)
+
+### AI & ML
+- `--openai` - OpenAI GPT models
+- `--anthropic` - Anthropic Claude SDK
+- `--gemini` - Google Gemini
+- `--vercelAI` - Vercel AI SDK (unified interface)
+
+### Cloud Storage
+- `--aws` - AWS S3 & SES
+- `--gcp` - Google Cloud Storage
+- `--azure` - Azure Blob Storage
+- `--cloudflareR2` - Cloudflare R2
 
 ### 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
+- `--resend` - Modern email service
+- `--sendgrid` - Enterprise email
+- `--nodemailer` - SMTP email
+- `--socketio` - WebSockets
+- `--sse` - Server-Sent Events
 
 ### 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
+- `--bullmq` - Redis-based job queue
+- `--inngest` - Serverless job orchestration
+- `--upstashRateLimit` - Upstash rate limiting
+- `--customRateLimit` - Custom rate limit middleware
+- `--sentry` - Error tracking
+- `--logtail` - Log aggregation
 
 ### Developer Experience
+- `--swagger` - Swagger/OpenAPI docs
+- `--scalar` - Modern API documentation
+- `--vitest` - Testing framework
+- `--zod` - Zod validation
+- `--yup` - Yup validation
 
-- **Swagger/OpenAPI** - Interactive API documentation
-- **Scalar** - Beautiful API documentation
-- **Vitest** - Fast unit testing framework
-- **Zod** - TypeScript-first schema validation
-- **Yup** - Object schema validation
+### Options
+- `--noInstall` - Skip dependency installation
+- `--noGit` - Skip git initialization
+- `--CI` - Non-interactive mode
 
-## Project Structure
+## 📝 Examples
 
-```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
+### Full-Stack API with PostgreSQL + JWT + AI
+```bash
+npx deploy-bbc my-api \
+  --hono \
+  --postgres \
+  --redis \
+  --jwt \
+  --openai \
+  --zod \
+  --swagger \
+  --vitest
 ```
 
-## Development
-
-### Prerequisites
-
-- Node.js >= 18.0.0
-- Bun >= 1.0.0 (recommended)
-
-### Commands
-
+### Microservice with Express + MongoDB
 ```bash
-# Development mode with hot reload
-bun run dev
-
-# Build the project
-bun run build
-
-# Type checking
-bun run type-check
+npx deploy-bbc user-service \
+  --express \
+  --mongodb \
+  --session \
+  --resend \
+  --bullmq \
+  --sentry
+```
 
-# Lint code
-bun run lint
+### Minimal Bun Native API
+```bash
+npx deploy-bbc fast-api \
+  --bun-native \
+  --postgres \
+  --jwt \
+  --zod
+```
 
-# Format code
-bun run format
+### AI-Powered Backend
+```bash
+npx deploy-bbc ai-backend \
+  --hono \
+  --postgres \
+  --jwt \
+  --anthropic \
+  --vercelAI \
+  --aws \
+  --zod \
+  --scalar
 ```
 
-### Contributing
+## 🏗️ Project Structure
 
-We welcome contributions! Please follow these steps:
+```
+my-project/
+├── src/
+│   ├── index.ts              # Application entry point
+│   ├── config/               # Configuration
+│   ├── middleware/           # Custom middleware
+│   ├── routes/               # API routes
+│   ├── types/                # TypeScript types
+│   └── utils/                # Utility functions
+├── docker-compose.yml        # Docker services
+├── Dockerfile                # Container configuration
+├── .env.example              # Environment variables template
+├── package.json              # Dependencies
+├── tsconfig.json             # TypeScript config
+└── README.md                 # Project documentation
+```
 
-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
+## 🚦 Getting Started with Your Project
 
-#### Coding Conventions
+After creating your project:
 
-This project follows specific naming conventions:
+```bash
+# Navigate to project
+cd my-project
 
-- **Files/Folders**: `kebab-case`
-- **Functions**: `snake_case`
-- **Variables**: `snake_case`
-- **Types**: `PascalCase` (use `type`, not `interface`)
-- **Constants**: `SCREAMING_SNAKE_CASE`
+# Copy environment variables
+cp .env.example .env
 
-See `CLAUDE.md` for complete guidelines.
+# Edit .env with your credentials
+nano .env
 
-## Docker Support
+# Start development server
+bun run dev
 
-Every generated project includes Docker configuration:
+# Start with Docker
+docker-compose up -d
+bun run dev
 
-```bash
-# Build and run with Docker Compose
-docker-compose up
+# Run tests
+bun test
 
-# Build Docker image
-docker build -t my-backend .
+# Build for production
+bun run build
+```
 
-# Run container
-docker run -p 8000:8000 my-backend
+## 🔧 Validation Example (Zod)
+
+When you select Zod validation, you get ready-to-use middleware:
+
+```typescript
+import { z } from "zod";
+import { validate, get_validated } from "./middleware/validate.js";
+
+const create_user_schema = z.object({
+  name: z.string().min(2),
+  email: z.string().email(),
+  age: z.number().int().min(18).optional(),
+});
+
+app.post(
+  "/users",
+  validate({ target: "body", schema: create_user_schema }),
+  (c) => {
+    const body = get_validated(c, "body");
+    // body is fully typed and validated
+    return c.json({ user: body });
+  }
+);
 ```
 
-## Environment Variables
+## 🐳 Docker Support
 
-Each integration adds its required environment variables to `.env.example`. Copy it to `.env` and fill in your values:
+Every project includes:
+- **Dockerfile** - Optimized multi-stage build
+- **docker-compose.yml** - Services orchestration
+- Database containers (PostgreSQL, MySQL, Redis)
+- Volume persistence
+- Network configuration
 
+Start everything with:
 ```bash
-cp .env.example .env
+docker-compose up -d
 ```
 
-## License
-
-MIT License - see LICENSE file for details
-
-## Author
+## 📚 Documentation
 
-### Aritra Sarkar
+Each generated project includes:
+- Comprehensive README.md
+- .env.example with all required variables
+- Example routes and middleware
+- TypeScript types and interfaces
+- Docker setup instructions
 
-- GitHub: [@aritra69](https://github.com/aritra69)
-- Email: <aritrasarkar2002@gmail.com>
+## 🤝 Contributing
 
-## Contributors
+Contributions are welcome! Please feel free to submit a Pull Request.
 
-This project exists thanks to all the people who contribute.
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
 
-[![Contributors](https://contrib.rocks/image?repo=aritra69/deploy-bbc)](https://github.com/aritra69/deploy-bbc/graphs/contributors)
+## 📄 License
 
-### How to Contribute
+MIT © [Aritra Sarkar](https://github.com/aritra69)
 
-We appreciate all contributions! See the [Contributing](#contributing) section above for guidelines.
+## 🙏 Acknowledgments
 
-## Support
+Built with:
+- [Bun](https://bun.sh) - Fast JavaScript runtime
+- [Hono](https://hono.dev) - Ultrafast web framework
+- [Clack](https://github.com/natemoo-re/clack) - Beautiful CLI prompts
+- [Drizzle ORM](https://orm.drizzle.team) - TypeScript ORM
+- [Zod](https://zod.dev) - TypeScript-first validation
 
-- Issues: [GitHub Issues](https://github.com/aritra69/deploy-bbc/issues)
-- Discussions: [GitHub Discussions](https://github.com/aritra69/deploy-bbc/discussions)
+## 🔗 Links
 
-## Acknowledgments
+- [GitHub Repository](https://github.com/aritra69/deploy-bbc)
+- [npm Package](https://www.npmjs.com/package/deploy-bbc)
+- [Report Issues](https://github.com/aritra69/deploy-bbc/issues)
 
-Built with:
+## ⭐ Show Your Support
 
-- [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
+Give a ⭐️ if this project helped you!
 
 ---
 
-**Star this repository if you find it helpful!**
+**Made with ❤️ by [Aritra Sarkar](https://github.com/aritra69)**