flash-builder 1.0.13 → 1.0.14

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.
package/README.md CHANGED
@@ -1,15 +1,281 @@
1
- # flash-builder
1
+ # ⚡ Flash Builder
2
2
 
3
- To install dependencies:
3
+ <div align="center">
4
+
5
+ ```
6
+ ________ __ ____ _ __ __
7
+ / ____/ /___ ______/ /_ / __ )__ __(_) /___/ /__ _____
8
+ / /_ / / __ `/ ___/ __ \ / __ / / / / / / __ / _ \/ ___/
9
+ / __/ / / /_/ (__ ) / / / / /_/ / /_/ / / / /_/ / __/ /
10
+ /_/ /_/\__,_/____/_/ /_/ /_____/\__,_/_/_/\__,_/\___/_/
11
+ ```
12
+
13
+ **A blazingly fast CLI tool for scaffolding modern backend projects**
14
+
15
+ [![npm version](https://img.shields.io/npm/v/flash-builder.svg)](https://www.npmjs.com/package/flash-builder)
16
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
17
+
18
+ [Installation](#-installation) • [Usage](#-usage) • [Commands](#-commands) • [Examples](#-examples)
19
+
20
+ </div>
21
+
22
+ ---
23
+
24
+ ## ✨ Features
25
+
26
+ - 🚀 **Lightning Fast** - Built with Bun for maximum performance
27
+ - 📦 **Zero Configuration** - Get started immediately with sensible defaults
28
+ - 🎯 **Multiple Templates** - Backend (Express) and MCP Server scaffolding
29
+ - 🔄 **Auto Install** - Automatically installs dependencies after project creation
30
+ - 🎨 **Modern Stack** - TypeScript, Express, and latest best practices
31
+ - 🛠️ **Flexible** - Generate in current directory or create new folders
32
+
33
+ ---
34
+
35
+ ## 📦 Installation
36
+
37
+ ### Global Installation
4
38
 
5
39
  ```bash
6
- bun install
40
+ bun install -g flash-builder@latest
7
41
  ```
8
42
 
9
- To run:
43
+ ---
44
+
45
+ ## 🚀 Usage
10
46
 
11
47
  ```bash
12
- bun run index.ts
48
+ fbi <command> [options]
13
49
  ```
14
50
 
15
- This project was created using `bun init` in bun v1.3.6. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
51
+ ### Quick Start
52
+
53
+ ```bash
54
+ # Create a new backend project
55
+ fbi be my-project-name
56
+
57
+ # Create in a specific subdirectory
58
+ fbi be my-project-name ./backend
59
+
60
+
61
+ # Create MCP server project
62
+ fbi mcp my-mcp-server
63
+
64
+
65
+ # Sync interface from Flash Builder
66
+ fbi sync
67
+ ```
68
+
69
+ ---
70
+
71
+ ## 📚 Commands
72
+
73
+ ### `be <project-name> [target-path]`
74
+
75
+ Initialize a new backend project with Express and TypeScript.
76
+
77
+ **Arguments:**
78
+ - `project-name` - Name of your project (used in package.json)
79
+ - `target-path` - (Optional) Target directory (`.` for current dir, `./path` for subdirectory)
80
+
81
+ **Generated Structure:**
82
+ ```
83
+ my-backend/
84
+ ├── src/
85
+ │ ├── routes/
86
+ │ ├── controllers/
87
+ │ ├── models/
88
+ │ ├── middlewares/
89
+ │ └── index.ts
90
+ ├── .env
91
+ ├── .gitignore
92
+ ├── package.json
93
+ └── README.md
94
+ ```
95
+
96
+ **Includes:**
97
+ - Express.js server setup
98
+ - TypeScript configuration
99
+ - Environment variables support
100
+ - Auto-installed dependencies
101
+ - Development scripts
102
+
103
+ ---
104
+
105
+ ### `mcp <project-name>`
106
+
107
+ Initialize a new MCP (Model Context Protocol) server project.
108
+
109
+ **Arguments:**
110
+ - `project-name` - Name of your MCP server project
111
+
112
+ **Generated Structure:**
113
+ ```
114
+ my-mcp-server/
115
+ ├── src/
116
+ │ ├── tools/
117
+ │ ├── resources/
118
+ │ └── index.ts
119
+ ├── .env
120
+ ├── .gitignore
121
+ ├── package.json
122
+ └── README.md
123
+ ```
124
+
125
+ **Includes:**
126
+ - MCP SDK setup
127
+ - TypeScript configuration
128
+ - Tools and resources directories
129
+ - Auto-installed dependencies
130
+
131
+ ---
132
+
133
+ ### `sync`
134
+
135
+ Sync the current backend interface with the application target.
136
+
137
+ **Usage:**
138
+ ```bash
139
+ fbi sync
140
+ ```
141
+
142
+ ---
143
+
144
+ ## 🎯 Examples
145
+
146
+ ### Create Backend Project
147
+
148
+ ```bash
149
+ # Standard - creates new folder
150
+ fbi be my-api
151
+
152
+ # In current directory
153
+ fbi be my-api .
154
+
155
+ # In subdirectory
156
+ fbi be my-api ./backend
157
+
158
+ # With verbose logging
159
+ fbi be my-api --verbose
160
+ ```
161
+
162
+ ### Create MCP Server
163
+
164
+ ```bash
165
+ # Standard MCP server
166
+ fbi mcp my-mcp-server
167
+
168
+ # With verbose logging
169
+ fbi mcp my-mcp-server -v
170
+ ```
171
+
172
+ ### After Project Creation
173
+
174
+ ```bash
175
+ cd my-api
176
+ bun run dev
177
+ ```
178
+
179
+ ---
180
+
181
+ ## ⚙️ Options
182
+
183
+ | Option | Alias | Description |
184
+ |--------|-------|-------------|
185
+ | `--verbose` | `-v` | Enable verbose logging |
186
+ | `--help` | `-h` | Show help message |
187
+ | `--version` | | Show version number |
188
+
189
+ ---
190
+
191
+ ## 🔧 Development
192
+
193
+ ### Prerequisites
194
+
195
+ - [Bun](https://bun.sh) v1.3.6 or higher
196
+
197
+ ### Setup
198
+
199
+ ```bash
200
+ # Clone the repository
201
+ git clone https://github.com/jefripunza/flash-builder-cli.git
202
+ cd flash-builder-cli
203
+
204
+ # Install dependencies
205
+ bun install
206
+
207
+ # Run in development
208
+ bun run start
209
+
210
+ # Build for production
211
+ bun run build
212
+
213
+ # Compile binary
214
+ bun run compile
215
+ ```
216
+
217
+ ---
218
+
219
+ ## 📝 Project Templates
220
+
221
+ ### Backend (Express) Template
222
+
223
+ - **Framework:** Express.js
224
+ - **Language:** TypeScript
225
+ - **Runtime:** Bun
226
+ - **Features:**
227
+ - REST API structure
228
+ - Environment variables
229
+ - Hot reload in development
230
+ - Production build script
231
+
232
+ ### MCP Server Template
233
+
234
+ - **Driver:** [jefriherditriyanto/langchain-mcp-api](https://hub.docker.com/r/jefriherditriyanto/langchain-mcp-api)
235
+ - **Runtime:** Docker
236
+
237
+ ---
238
+
239
+ ## 🤝 Contributing
240
+
241
+ Contributions are welcome! Please feel free to submit a Pull Request.
242
+
243
+ 1. Fork the repository
244
+ 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
245
+ 3. Commit your changes (`git commit -m 'Add some amazing feature'`)
246
+ 4. Push to the branch (`git push origin feature/amazing-feature`)
247
+ 5. Open a Pull Request
248
+
249
+ ---
250
+
251
+ ## 📄 License
252
+
253
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
254
+
255
+ ---
256
+
257
+ ## 👤 Author
258
+
259
+ <a href="https://github.com/jefripunza">
260
+ <img src="https://github.com/jefripunza.png" width="50" height="50" alt="Jefri Herdi Triyanto" style="border-radius: 50%;">
261
+ </a>
262
+
263
+ **Jefri Herdi Triyanto** ([@jefripunza](https://github.com/jefripunza))
264
+
265
+ ---
266
+
267
+ ## 🙏 Acknowledgments
268
+
269
+ - Built with [Bun](https://bun.sh) - A fast all-in-one JavaScript runtime
270
+ - Powered by [meow](https://github.com/sindresorhus/meow) - CLI helper
271
+ - Inspired by modern development workflows
272
+
273
+ ---
274
+
275
+ <div align="center">
276
+
277
+ **⚡ Flash Builder - Build faster, ship sooner**
278
+
279
+ Made with ❤️ by [Jefri Herdi Triyanto](https://github.com/jefripunza)
280
+
281
+ </div>
package/dist/index.cjs CHANGED
@@ -9819,7 +9819,7 @@ var meow = (helpText, options = {}) => {
9819
9819
  };
9820
9820
 
9821
9821
  // version.ts
9822
- var version = "1.0.13";
9822
+ var version = "1.0.14";
9823
9823
  var version_default = version;
9824
9824
 
9825
9825
  // src/banner.ts
package/dist/index.js CHANGED
@@ -9820,7 +9820,7 @@ var meow = (helpText, options = {}) => {
9820
9820
  };
9821
9821
 
9822
9822
  // version.ts
9823
- var version = "1.0.13";
9823
+ var version = "1.0.14";
9824
9824
  var version_default = version;
9825
9825
 
9826
9826
  // src/banner.ts
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "flash-builder",
3
- "version": "1.0.13",
3
+ "version": "1.0.14",
4
4
  "description": "",
5
5
  "homepage": "https://github.com/jefripunza/flash-builder-cli#readme",
6
6
  "repository": {