deploy-bbc 1.2.1 → 1.2.3

package/README.md

@@ -1,358 +1,219 @@
 # deploy-bbc
 
-> A powerful CLI tool to bootstrap production-ready backend applications with Bun
+<p align="center">
+  <b>Best Backend Code</b> — A powerful CLI to bootstrap production-ready backend applications with Bun
+</p>
 
-## 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
+<p align="center">
+  <img src="https://img.shields.io/npm/v/deploy-bbc" alt="npm version" />
+  <img src="https://img.shields.io/npm/dt/deploy-bbc" alt="npm downloads" />
+  <img src="https://img.shields.io/github/stars/aritra69/deploy-bbc" alt="github stars" />
+  <img src="https://img.shields.io/github/license/aritra69/deploy-bbc" alt="license" />
+</p>
 
-```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
+## Overview
 
-# Install dependencies
-bun install
+`deploy-bbc` is an interactive command-line tool that scaffolds modern, type-safe backend applications using Bun.
 
-# Build
-bun run build
+It ships with production-ready defaults, optional integrations, Docker support, and a clean architecture so you can focus on building features instead of wiring infrastructure.
 
-# Link for local development
-npm link
-```
+---
 
-## Usage
+## Tech Stack
 
-### Interactive Mode
+<p align="center">
+  <img height="40" src="https://bun.sh/logo.svg" alt="Bun" />
+  <img height="40" src="https://hono.dev/images/logo.svg" alt="Hono" />
+  <img height="40" src="https://raw.githubusercontent.com/expressjs/expressjs.com/gh-pages/images/favicon.png" alt="Express" />
+  <img height="40" src="https://www.typescriptlang.org/icons/icon-48x48.png" alt="TypeScript" />
+  <img height="40" src="https://www.docker.com/wp-content/uploads/2022/03/Moby-logo.png" alt="Docker" />
+</p>
 
-Simply run the CLI and answer the prompts:
+---
 
-```bash
-deploy-bbc my-backend
-```
+## Features
 
-You'll be prompted to:
+- ⚡ **Three framework options**: Hono, Express, or Bun Native HTTP
+- 🚀 **Production-ready templates** with best practices
+- 🔌 **30+ integrations** (databases, auth, AI, cloud, infra)
+- 🛡️ **Fully type-safe** with strict TypeScript
+- 🐳 **Dockerfile and docker-compose** included
+- 💎 **Strong developer experience** with testing and docs
+- ⚙️ **Zero-config defaults** that work out of the box
 
-1. Choose a framework (Hono, Express, or Bun Native)
-2. Select integrations (databases, auth, AI services, etc.)
-3. Configure additional options
+---
 
-### CLI Flags
+## Quick Start
 
 ```bash
-deploy-bbc my-backend [options]
+npx deploy-bbc my-backend
+# or
+bunx deploy-bbc my-backend
 ```
 
-#### 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
+## Framework Options
 
-### Example Commands
+<p align="center">
+  <img height="36" src="https://hono.dev/images/logo.svg" alt="Hono" />
+  <img height="36" src="https://raw.githubusercontent.com/expressjs/expressjs.com/gh-pages/images/favicon.png" alt="Express" />
+  <img height="36" src="https://bun.sh/logo.svg" alt="Bun" />
+</p>
 
-```bash
-# Create a Hono app with PostgreSQL and JWT auth
-deploy-bbc my-api --postgres --jwt
+- **Hono** (default) – lightweight and edge-ready
+- **Express** – battle-tested Node.js framework
+- **Bun Native HTTP** – minimal overhead, maximum performance
 
-# 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
+## Databases and Caching
 
-# Create without Git initialization
-deploy-bbc my-api --no-git --postgres --jwt
-```
+<p align="center">
+  <img height="40" src="https://www.postgresql.org/media/img/about/press/elephant.png" alt="PostgreSQL" />
+  <img height="40" src="https://www.mysql.com/common/logos/logo-mysql-170x115.png" alt="MySQL" />
+  <img height="40" src="https://www.mongodb.com/assets/images/global/favicon.ico" alt="MongoDB" />
+  <img height="40" src="https://cdn.brandfetch.io/idwlYcQpHB/theme/dark/symbol.svg?c=1bxid64Mup7aczewSAYMX&t=1668515608635" alt="Redis" />
+</p>
 
-## Framework Options
+- **PostgreSQL** with Drizzle ORM
+- **MySQL** with Drizzle ORM
+- **MongoDB** with Mongoose
+- **Redis** for caching and queues
 
-### Hono (Default)
+---
 
-Ultra-fast web framework optimized for Bun and edge runtimes. Lightweight and type-safe.
+## Authentication
 
-### Express
+<p align="center">
+  <img height="36" src="https://jwt.io/img/pic_logo.svg" alt="JWT" />
+  <img height="36" src="https://oauth.net/images/oauth-logo-square.png" alt="OAuth" />
+</p>
 
-Battle-tested Node.js framework with extensive ecosystem and middleware support.
+- JWT authentication
+- OAuth 2.0 providers
+- Session-based authentication
 
-### Bun Native HTTP
+---
 
-Use Bun's native HTTP server for maximum performance with minimal overhead.
+## AI Integrations
 
-## Available Integrations
+<p align="center">
+  <img height="40" src="https://openai.com/favicon.ico" alt="OpenAI" />
+  <img height="40" src="https://www.anthropic.com/favicon.ico" alt="Anthropic" />
+  <img height="40" src="https://upload.wikimedia.org/wikipedia/commons/8/8a/Google_Gemini_logo.svg" alt="Gemini" />
+  <img height="40" src="https://vercel.com/favicon.ico" alt="Vercel" />
+</p>
 
-### Databases
+- OpenAI
+- Anthropic Claude
+- Google Gemini
+- Vercel AI SDK
 
-- **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
+## Cloud and Storage
 
-- **JWT** - JSON Web Token authentication with utilities
-- **OAuth 2.0** - Third-party authentication (Google, GitHub, etc.)
-- **Session** - Traditional session-based authentication
+<p align="center">
+  <img height="36" src="https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png" alt="AWS" />
+  <img height="36" src="https://cloud.google.com/_static/cloud/images/social-icon-google-cloud-1200-630.png" alt="GCP" />
+  <img height="36" src="https://azure.microsoft.com/svghandler/azure-logo.svg" alt="Azure" />
+  <img height="36" src="https://cdn.brandfetch.io/idJ3Cg8ymG/w/400/h/400/theme/dark/icon.jpeg?c=1bxid64Mup7aczewSAYMX&t=1668515610854" alt="Cloudflare" />
+</p>
 
-### AI & Machine Learning
+- **AWS** (S3, SES)
+- **Google Cloud Platform**
+- **Azure**
+- **Cloudflare R2**
 
-- **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
+## Communication and Realtime
 
-- **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
+<p align="center">
+  <img height="36" src="https://cdn.brandfetch.io/id0BqaqET6/w/400/h/400/theme/dark/icon.jpeg?c=1bxid64Mup7aczewSAYMX&t=1748366671512" alt="Resend" />
+  <img height="36" src="https://sendgrid.com/favicon.ico" alt="SendGrid" />
+  <img height="36" src="https://socket.io/images/logo.svg" alt="Socket.IO" />
+</p>
 
-### Communication
+- Resend
+- SendGrid
+- Nodemailer
+- Socket.IO
+- Server-Sent Events (SSE)
 
-- **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
+## Developer Experience
 
-- **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
+<p align="center">
+  <img height="36" src="https://vitest.dev/logo.svg" alt="Vitest" />
+  <img height="36" src="https://zod.dev/_next/image?url=%2Flogo%2Flogo-glow.png&w=640&q=100" alt="Zod" />
+  <img height="36" src="https://static1.smartbear.co/swagger/media/assets/images/swagger_logo.svg" alt="Swagger" />
+</p>
 
-### Developer Experience
+- Vitest
+- Zod and Yup
+- Swagger / OpenAPI
+- Scalar documentation
 
-- **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
+src/
+├── config/
+├── middleware/
+├── routes/
+├── services/
+├── db/
+├── utils/
+├── types/
+└── index.ts
 ```
 
-### 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
+Dockerfile and docker-compose are included by default.
 
-Each integration adds its required environment variables to `.env.example`. Copy it to `.env` and fill in your values:
+---
 
-```bash
-cp .env.example .env
-```
+## Contributors
 
-## License
+<a href="https://github.com/aritra69/deploy-bbc/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=aritra69/deploy-bbc" alt="Contributors" />
+</a>
 
-MIT License - see LICENSE file for details
+A big thank you to all the contributors who have helped make this project better! 🙏
+
+---
 
 ## Author
 
-### Aritra Sarkar
+**Aritra Sarkar**
 
-- GitHub: [@aritra69](https://github.com/aritra69)
+- GitHub: [https://github.com/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)
+## License
 
-### How to Contribute
+MIT License
 
-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
-
----
+If this project helps you, consider ⭐ starring the repository.
 
-**Star this repository if you find it helpful!**
+Issues, pull requests, and discussions are welcome!