deploy-bbc 1.2.2 โ†’ 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +158 -284
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,345 +1,219 @@
1
- # ๐Ÿš€ deploy-bbc (Best Backend Code)
1
+ # deploy-bbc
2
2
 
3
- Bootstrap production-ready backend projects with Bun, TypeScript, and Docker in seconds.
3
+ <p align="center">
4
+ <b>Best Backend Code</b> โ€” A powerful CLI to bootstrap production-ready backend applications with Bun
5
+ </p>
4
6
 
5
- [![npm version](https://img.shields.io/npm/v/deploy-bbc.svg)](https://www.npmjs.com/package/deploy-bbc)
6
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
+ <p align="center">
8
+ <img src="https://img.shields.io/npm/v/deploy-bbc" alt="npm version" />
9
+ <img src="https://img.shields.io/npm/dt/deploy-bbc" alt="npm downloads" />
10
+ <img src="https://img.shields.io/github/stars/aritra69/deploy-bbc" alt="github stars" />
11
+ <img src="https://img.shields.io/github/license/aritra69/deploy-bbc" alt="license" />
12
+ </p>
7
13
 
8
- ## โœจ Features
14
+ ---
9
15
 
10
- - ๐ŸŽฏ **Interactive CLI** - Step-by-step project setup with beautiful prompts
11
- - โšก **3 Framework Options** - Choose between Hono, Express, or Bun Native
12
- - ๐Ÿ—„๏ธ **Multiple Databases** - PostgreSQL, MySQL, MongoDB, Redis with Drizzle ORM/Mongoose
13
- - ๐Ÿ” **Authentication** - JWT, OAuth 2.0, Session-based auth
14
- - ๐Ÿค– **AI Integration** - OpenAI, Anthropic Claude, Google Gemini, Vercel AI SDK
15
- - โ˜๏ธ **Cloud Storage** - AWS S3, Google Cloud, Azure, Cloudflare R2
16
- - ๐Ÿ“ง **Email Services** - Resend, SendGrid, NodeMailer
17
- - ๐Ÿ”„ **Real-time** - Socket.io, Server-Sent Events
18
- - ๐Ÿ“ **Validation** - Zod or Yup for request validation
19
- - ๐Ÿ“Š **Background Jobs** - BullMQ, Inngest
20
- - ๐Ÿ“š **API Documentation** - Swagger/OpenAPI, Scalar
21
- - ๐Ÿงช **Testing** - Vitest with Supertest
22
- - ๐Ÿณ **Docker Ready** - Dockerfile + docker-compose.yml included
23
- - ๐Ÿ“ฆ **TypeScript** - Full type safety out of the box
16
+ ## Overview
24
17
 
25
- ## ๐Ÿš€ Quick Start
18
+ `deploy-bbc` is an interactive command-line tool that scaffolds modern, type-safe backend applications using Bun.
26
19
 
27
- ```bash
28
- # Using npx (recommended)
29
- npx deploy-bbc my-awesome-api
20
+ 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.
30
21
 
31
- # Using npm
32
- npm create deploy-bbc my-awesome-api
22
+ ---
33
23
 
34
- # Using bun
35
- bunx deploy-bbc my-awesome-api
36
- ```
24
+ ## Tech Stack
37
25
 
38
- ## ๐Ÿ“ฆ Installation
26
+ <p align="center">
27
+ <img height="40" src="https://bun.sh/logo.svg" alt="Bun" />
28
+ <img height="40" src="https://hono.dev/images/logo.svg" alt="Hono" />
29
+ <img height="40" src="https://raw.githubusercontent.com/expressjs/expressjs.com/gh-pages/images/favicon.png" alt="Express" />
30
+ <img height="40" src="https://www.typescriptlang.org/icons/icon-48x48.png" alt="TypeScript" />
31
+ <img height="40" src="https://www.docker.com/wp-content/uploads/2022/03/Moby-logo.png" alt="Docker" />
32
+ </p>
39
33
 
40
- ```bash
41
- # Install globally
42
- npm install -g deploy-bbc
34
+ ---
43
35
 
44
- # Use directly with npx
45
- npx deploy-bbc
46
- ```
36
+ ## Features
47
37
 
48
- ## ๐ŸŽจ Usage
38
+ - โšก **Three framework options**: Hono, Express, or Bun Native HTTP
39
+ - ๐Ÿš€ **Production-ready templates** with best practices
40
+ - ๐Ÿ”Œ **30+ integrations** (databases, auth, AI, cloud, infra)
41
+ - ๐Ÿ›ก๏ธ **Fully type-safe** with strict TypeScript
42
+ - ๐Ÿณ **Dockerfile and docker-compose** included
43
+ - ๐Ÿ’Ž **Strong developer experience** with testing and docs
44
+ - โš™๏ธ **Zero-config defaults** that work out of the box
49
45
 
50
- ### Interactive Mode
46
+ ---
51
47
 
52
- Simply run the command and follow the prompts:
48
+ ## Quick Start
53
49
 
54
50
  ```bash
55
- npx deploy-bbc my-project
51
+ npx deploy-bbc my-backend
52
+ # or
53
+ bunx deploy-bbc my-backend
56
54
  ```
57
55
 
58
- You'll be asked to select:
59
- 1. **Project name** - Your application name
60
- 2. **Framework** - Hono (recommended), Express, or Bun Native
61
- 3. **Database(s)** - PostgreSQL, MySQL, MongoDB, Redis
62
- 4. **Authentication** - JWT, OAuth, Session-based
63
- 5. **AI Providers** - OpenAI, Anthropic, Gemini
64
- 6. **Email Service** - Resend, SendGrid, NodeMailer
65
- 7. **Real-time** - Socket.io or SSE
66
- 8. **Background Jobs** - BullMQ or Inngest
67
- 9. **Validation** - Zod or Yup
68
- 10. **API Docs** - Swagger or Scalar
69
- 11. **Testing** - Vitest setup
56
+ ---
70
57
 
71
- ### CI Mode (Non-Interactive)
58
+ ## Framework Options
72
59
 
73
- Perfect for automated deployments:
60
+ <p align="center">
61
+ <img height="36" src="https://hono.dev/images/logo.svg" alt="Hono" />
62
+ <img height="36" src="https://raw.githubusercontent.com/expressjs/expressjs.com/gh-pages/images/favicon.png" alt="Express" />
63
+ <img height="36" src="https://bun.sh/logo.svg" alt="Bun" />
64
+ </p>
74
65
 
75
- ```bash
76
- npx deploy-bbc my-project \
77
- --CI \
78
- --express \
79
- --postgres \
80
- --redis \
81
- --jwt \
82
- --zod \
83
- --vitest \
84
- --swagger \
85
- --noGit
86
- ```
66
+ - **Hono** (default) โ€“ lightweight and edge-ready
67
+ - **Express** โ€“ battle-tested Node.js framework
68
+ - **Bun Native HTTP** โ€“ minimal overhead, maximum performance
87
69
 
88
- ## ๐Ÿ› ๏ธ Framework Options
70
+ ---
89
71
 
90
- ### Hono (Default)
91
- ```bash
92
- npx deploy-bbc my-app --hono
93
- ```
94
- - Ultrafast web framework built for the edge
95
- - Tiny footprint (~12KB)
96
- - Express-like API
97
- - **Recommended for most projects**
72
+ ## Databases and Caching
98
73
 
99
- ### Express
100
- ```bash
101
- npx deploy-bbc my-app --express
102
- ```
103
- - Battle-tested Node.js framework
104
- - Huge ecosystem
105
- - Familiar to most developers
74
+ <p align="center">
75
+ <img height="40" src="https://www.postgresql.org/media/img/about/press/elephant.png" alt="PostgreSQL" />
76
+ <img height="40" src="https://www.mysql.com/common/logos/logo-mysql-170x115.png" alt="MySQL" />
77
+ <img height="40" src="https://www.mongodb.com/assets/images/global/favicon.ico" alt="MongoDB" />
78
+ <img height="40" src="https://cdn.brandfetch.io/idwlYcQpHB/theme/dark/symbol.svg?c=1bxid64Mup7aczewSAYMX&t=1668515608635" alt="Redis" />
79
+ </p>
106
80
 
107
- ### Bun Native
108
- ```bash
109
- npx deploy-bbc my-app --bun-native
110
- ```
111
- - Native Bun.serve() API
112
- - Zero dependencies
113
- - Maximum performance
114
-
115
- ## ๐Ÿ“Š Available Packages
116
-
117
- ### Databases
118
- - `--postgres` - PostgreSQL with Drizzle ORM
119
- - `--mysql` - MySQL with Drizzle ORM
120
- - `--mongodb` - MongoDB with Mongoose
121
- - `--redis` - Redis for caching & sessions
122
-
123
- ### Authentication
124
- - `--jwt` - JSON Web Token authentication
125
- - `--oauth` - OAuth 2.0 (Google, GitHub)
126
- - `--session` - Session-based auth (requires Redis)
127
-
128
- ### AI & ML
129
- - `--openai` - OpenAI GPT models
130
- - `--anthropic` - Anthropic Claude SDK
131
- - `--gemini` - Google Gemini
132
- - `--vercelAI` - Vercel AI SDK (unified interface)
133
-
134
- ### Cloud Storage
135
- - `--aws` - AWS S3 & SES
136
- - `--gcp` - Google Cloud Storage
137
- - `--azure` - Azure Blob Storage
138
- - `--cloudflareR2` - Cloudflare R2
139
-
140
- ### Communication
141
- - `--resend` - Modern email service
142
- - `--sendgrid` - Enterprise email
143
- - `--nodemailer` - SMTP email
144
- - `--socketio` - WebSockets
145
- - `--sse` - Server-Sent Events
146
-
147
- ### Infrastructure
148
- - `--bullmq` - Redis-based job queue
149
- - `--inngest` - Serverless job orchestration
150
- - `--upstashRateLimit` - Upstash rate limiting
151
- - `--customRateLimit` - Custom rate limit middleware
152
- - `--sentry` - Error tracking
153
- - `--logtail` - Log aggregation
154
-
155
- ### Developer Experience
156
- - `--swagger` - Swagger/OpenAPI docs
157
- - `--scalar` - Modern API documentation
158
- - `--vitest` - Testing framework
159
- - `--zod` - Zod validation
160
- - `--yup` - Yup validation
161
-
162
- ### Options
163
- - `--noInstall` - Skip dependency installation
164
- - `--noGit` - Skip git initialization
165
- - `--CI` - Non-interactive mode
166
-
167
- ## ๐Ÿ“ Examples
168
-
169
- ### Full-Stack API with PostgreSQL + JWT + AI
170
- ```bash
171
- npx deploy-bbc my-api \
172
- --hono \
173
- --postgres \
174
- --redis \
175
- --jwt \
176
- --openai \
177
- --zod \
178
- --swagger \
179
- --vitest
180
- ```
81
+ - **PostgreSQL** with Drizzle ORM
82
+ - **MySQL** with Drizzle ORM
83
+ - **MongoDB** with Mongoose
84
+ - **Redis** for caching and queues
181
85
 
182
- ### Microservice with Express + MongoDB
183
- ```bash
184
- npx deploy-bbc user-service \
185
- --express \
186
- --mongodb \
187
- --session \
188
- --resend \
189
- --bullmq \
190
- --sentry
191
- ```
86
+ ---
192
87
 
193
- ### Minimal Bun Native API
194
- ```bash
195
- npx deploy-bbc fast-api \
196
- --bun-native \
197
- --postgres \
198
- --jwt \
199
- --zod
200
- ```
88
+ ## Authentication
201
89
 
202
- ### AI-Powered Backend
203
- ```bash
204
- npx deploy-bbc ai-backend \
205
- --hono \
206
- --postgres \
207
- --jwt \
208
- --anthropic \
209
- --vercelAI \
210
- --aws \
211
- --zod \
212
- --scalar
213
- ```
90
+ <p align="center">
91
+ <img height="36" src="https://jwt.io/img/pic_logo.svg" alt="JWT" />
92
+ <img height="36" src="https://oauth.net/images/oauth-logo-square.png" alt="OAuth" />
93
+ </p>
214
94
 
215
- ## ๐Ÿ—๏ธ Project Structure
95
+ - JWT authentication
96
+ - OAuth 2.0 providers
97
+ - Session-based authentication
216
98
 
217
- ```
218
- my-project/
219
- โ”œโ”€โ”€ src/
220
- โ”‚ โ”œโ”€โ”€ index.ts # Application entry point
221
- โ”‚ โ”œโ”€โ”€ config/ # Configuration
222
- โ”‚ โ”œโ”€โ”€ middleware/ # Custom middleware
223
- โ”‚ โ”œโ”€โ”€ routes/ # API routes
224
- โ”‚ โ”œโ”€โ”€ types/ # TypeScript types
225
- โ”‚ โ””โ”€โ”€ utils/ # Utility functions
226
- โ”œโ”€โ”€ docker-compose.yml # Docker services
227
- โ”œโ”€โ”€ Dockerfile # Container configuration
228
- โ”œโ”€โ”€ .env.example # Environment variables template
229
- โ”œโ”€โ”€ package.json # Dependencies
230
- โ”œโ”€โ”€ tsconfig.json # TypeScript config
231
- โ””โ”€โ”€ README.md # Project documentation
232
- ```
99
+ ---
233
100
 
234
- ## ๐Ÿšฆ Getting Started with Your Project
101
+ ## AI Integrations
235
102
 
236
- After creating your project:
103
+ <p align="center">
104
+ <img height="40" src="https://openai.com/favicon.ico" alt="OpenAI" />
105
+ <img height="40" src="https://www.anthropic.com/favicon.ico" alt="Anthropic" />
106
+ <img height="40" src="https://upload.wikimedia.org/wikipedia/commons/8/8a/Google_Gemini_logo.svg" alt="Gemini" />
107
+ <img height="40" src="https://vercel.com/favicon.ico" alt="Vercel" />
108
+ </p>
237
109
 
238
- ```bash
239
- # Navigate to project
240
- cd my-project
110
+ - OpenAI
111
+ - Anthropic Claude
112
+ - Google Gemini
113
+ - Vercel AI SDK
241
114
 
242
- # Copy environment variables
243
- cp .env.example .env
115
+ ---
244
116
 
245
- # Edit .env with your credentials
246
- nano .env
117
+ ## Cloud and Storage
247
118
 
248
- # Start development server
249
- bun run dev
119
+ <p align="center">
120
+ <img height="36" src="https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png" alt="AWS" />
121
+ <img height="36" src="https://cloud.google.com/_static/cloud/images/social-icon-google-cloud-1200-630.png" alt="GCP" />
122
+ <img height="36" src="https://azure.microsoft.com/svghandler/azure-logo.svg" alt="Azure" />
123
+ <img height="36" src="https://cdn.brandfetch.io/idJ3Cg8ymG/w/400/h/400/theme/dark/icon.jpeg?c=1bxid64Mup7aczewSAYMX&t=1668515610854" alt="Cloudflare" />
124
+ </p>
250
125
 
251
- # Start with Docker
252
- docker-compose up -d
253
- bun run dev
126
+ - **AWS** (S3, SES)
127
+ - **Google Cloud Platform**
128
+ - **Azure**
129
+ - **Cloudflare R2**
254
130
 
255
- # Run tests
256
- bun test
131
+ ---
257
132
 
258
- # Build for production
259
- bun run build
260
- ```
133
+ ## Communication and Realtime
134
+
135
+ <p align="center">
136
+ <img height="36" src="https://cdn.brandfetch.io/id0BqaqET6/w/400/h/400/theme/dark/icon.jpeg?c=1bxid64Mup7aczewSAYMX&t=1748366671512" alt="Resend" />
137
+ <img height="36" src="https://sendgrid.com/favicon.ico" alt="SendGrid" />
138
+ <img height="36" src="https://socket.io/images/logo.svg" alt="Socket.IO" />
139
+ </p>
140
+
141
+ - Resend
142
+ - SendGrid
143
+ - Nodemailer
144
+ - Socket.IO
145
+ - Server-Sent Events (SSE)
146
+
147
+ ---
148
+
149
+ ## Developer Experience
261
150
 
262
- ## ๐Ÿ”ง Validation Example (Zod)
263
-
264
- When you select Zod validation, you get ready-to-use middleware:
265
-
266
- ```typescript
267
- import { z } from "zod";
268
- import { validate, get_validated } from "./middleware/validate.js";
269
-
270
- const create_user_schema = z.object({
271
- name: z.string().min(2),
272
- email: z.string().email(),
273
- age: z.number().int().min(18).optional(),
274
- });
275
-
276
- app.post(
277
- "/users",
278
- validate({ target: "body", schema: create_user_schema }),
279
- (c) => {
280
- const body = get_validated(c, "body");
281
- // body is fully typed and validated
282
- return c.json({ user: body });
283
- }
284
- );
151
+ <p align="center">
152
+ <img height="36" src="https://vitest.dev/logo.svg" alt="Vitest" />
153
+ <img height="36" src="https://zod.dev/_next/image?url=%2Flogo%2Flogo-glow.png&w=640&q=100" alt="Zod" />
154
+ <img height="36" src="https://static1.smartbear.co/swagger/media/assets/images/swagger_logo.svg" alt="Swagger" />
155
+ </p>
156
+
157
+ - Vitest
158
+ - Zod and Yup
159
+ - Swagger / OpenAPI
160
+ - Scalar documentation
161
+
162
+ ---
163
+
164
+ ## Project Structure
165
+
166
+ ```
167
+ src/
168
+ โ”œโ”€โ”€ config/
169
+ โ”œโ”€โ”€ middleware/
170
+ โ”œโ”€โ”€ routes/
171
+ โ”œโ”€โ”€ services/
172
+ โ”œโ”€โ”€ db/
173
+ โ”œโ”€โ”€ utils/
174
+ โ”œโ”€โ”€ types/
175
+ โ””โ”€โ”€ index.ts
285
176
  ```
286
177
 
287
- ## ๐Ÿณ Docker Support
178
+ ---
288
179
 
289
- Every project includes:
290
- - **Dockerfile** - Optimized multi-stage build
291
- - **docker-compose.yml** - Services orchestration
292
- - Database containers (PostgreSQL, MySQL, Redis)
293
- - Volume persistence
294
- - Network configuration
180
+ ## Docker Support
295
181
 
296
- Start everything with:
297
182
  ```bash
298
- docker-compose up -d
183
+ docker-compose up
299
184
  ```
300
185
 
301
- ## ๐Ÿ“š Documentation
186
+ Dockerfile and docker-compose are included by default.
302
187
 
303
- Each generated project includes:
304
- - Comprehensive README.md
305
- - .env.example with all required variables
306
- - Example routes and middleware
307
- - TypeScript types and interfaces
308
- - Docker setup instructions
309
-
310
- ## ๐Ÿค Contributing
188
+ ---
311
189
 
312
- Contributions are welcome! Please feel free to submit a Pull Request.
190
+ ## Contributors
313
191
 
314
- 1. Fork the repository
315
- 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
316
- 3. Commit your changes (`git commit -m 'Add some amazing feature'`)
317
- 4. Push to the branch (`git push origin feature/amazing-feature`)
318
- 5. Open a Pull Request
192
+ <a href="https://github.com/aritra69/deploy-bbc/graphs/contributors">
193
+ <img src="https://contrib.rocks/image?repo=aritra69/deploy-bbc" alt="Contributors" />
194
+ </a>
319
195
 
320
- ## ๐Ÿ“„ License
196
+ A big thank you to all the contributors who have helped make this project better! ๐Ÿ™
321
197
 
322
- MIT ยฉ [Aritra Sarkar](https://github.com/aritra69)
198
+ ---
323
199
 
324
- ## ๐Ÿ™ Acknowledgments
200
+ ## Author
325
201
 
326
- Built with:
327
- - [Bun](https://bun.sh) - Fast JavaScript runtime
328
- - [Hono](https://hono.dev) - Ultrafast web framework
329
- - [Clack](https://github.com/natemoo-re/clack) - Beautiful CLI prompts
330
- - [Drizzle ORM](https://orm.drizzle.team) - TypeScript ORM
331
- - [Zod](https://zod.dev) - TypeScript-first validation
202
+ **Aritra Sarkar**
332
203
 
333
- ## ๐Ÿ”— Links
204
+ - GitHub: [https://github.com/aritra69](https://github.com/aritra69)
205
+ - Email: <aritrasarkar2002@gmail.com>
334
206
 
335
- - [GitHub Repository](https://github.com/aritra69/deploy-bbc)
336
- - [npm Package](https://www.npmjs.com/package/deploy-bbc)
337
- - [Report Issues](https://github.com/aritra69/deploy-bbc/issues)
207
+ ---
338
208
 
339
- ## โญ Show Your Support
209
+ ## License
340
210
 
341
- Give a โญ๏ธ if this project helped you!
211
+ MIT License
342
212
 
343
213
  ---
344
214
 
345
- **Made with โค๏ธ by [Aritra Sarkar](https://github.com/aritra69)**
215
+ ## Support
216
+
217
+ If this project helps you, consider โญ starring the repository.
218
+
219
+ Issues, pull requests, and discussions are welcome!
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "deploy-bbc",
3
- "version": "1.2.2",
3
+ "version": "1.2.3",
4
4
  "description": "CLI to bootstrap production-ready backends with Bun (Best Backend Code)",
5
5
  "type": "module",
6
6
  "bin": {