blux-start 1.0.0 → 1.1.0
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/package.json +1 -1
- package/readme.md +27 -0
package/package.json
CHANGED
package/readme.md
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# blux-start
|
|
2
|
+
|
|
3
|
+
A zero-configuration CLI boilerplate generator to kickstart Node.js applications with a production-ready stack.
|
|
4
|
+
|
|
5
|
+
## ✨ Features
|
|
6
|
+
|
|
7
|
+
* **TypeScript** - Fully configured compiler and path aliases
|
|
8
|
+
* **Express** - Fast, unopinionated, minimalist web framework
|
|
9
|
+
* **MSSQL** - Pre-configured Microsoft SQL Server database integration
|
|
10
|
+
* **Structure** - Organized folder layout for scalable architecture
|
|
11
|
+
|
|
12
|
+
## 🚀 Quick Start
|
|
13
|
+
|
|
14
|
+
You can generate a new project instantly without installing the package globally. Run the following command in your terminal:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx blux-start@latest init <projectName>
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Replace `<projectName>` with the actual name of your project folder.
|
|
21
|
+
|
|
22
|
+
## 📋 Prerequisites
|
|
23
|
+
|
|
24
|
+
Before running the boilerplate, ensure you have the following installed on your machine:
|
|
25
|
+
|
|
26
|
+
* **Node.js** (v18.0.0 or higher recommended)
|
|
27
|
+
* **npm** (v9.0.0 or higher)
|