quick-scaffolds-cli 1.2.0 → 1.2.1
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 +75 -49
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,30 +1,27 @@
|
|
|
1
1
|
# quick-scaffolds-cli
|
|
2
2
|
|
|
3
|
-
A lightweight
|
|
3
|
+
A lightweight interactive CLI for scaffolding starter web projects quickly.
|
|
4
4
|
|
|
5
5
|
## Overview
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
quick-scaffolds-cli generates a ready-to-use project from templates with a simple prompt flow.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Current release: v1.2.1
|
|
10
10
|
|
|
11
11
|
## Quick Start
|
|
12
12
|
|
|
13
|
-
### Global
|
|
13
|
+
### Global install
|
|
14
14
|
|
|
15
|
-
Install
|
|
15
|
+
Install once and use the command anywhere:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
npm install -g quick-scaffolds-cli
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Then create a new project:
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
19
|
ct-pro
|
|
25
20
|
```
|
|
26
21
|
|
|
27
|
-
###
|
|
22
|
+
### Use with npx
|
|
23
|
+
|
|
24
|
+
Run without installing globally:
|
|
28
25
|
|
|
29
26
|
```bash
|
|
30
27
|
npx quick-scaffolds-cli
|
|
@@ -32,28 +29,32 @@ npx quick-scaffolds-cli
|
|
|
32
29
|
|
|
33
30
|
## Usage
|
|
34
31
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
Run the command and follow the interactive prompts:
|
|
32
|
+
Run the CLI and answer two prompts:
|
|
38
33
|
|
|
39
34
|
```bash
|
|
40
35
|
ct-pro
|
|
41
36
|
? What is your project name? my-awesome-app
|
|
42
|
-
? What do you want to build?
|
|
43
|
-
|
|
37
|
+
? What do you want to build?
|
|
38
|
+
Static HTML/CSS/JS
|
|
39
|
+
React starter
|
|
44
40
|
```
|
|
45
41
|
|
|
46
|
-
|
|
42
|
+
Prompt details:
|
|
47
43
|
|
|
48
|
-
1.
|
|
49
|
-
2.
|
|
50
|
-
-
|
|
44
|
+
1. Project name (default: my-new-project)
|
|
45
|
+
2. Project type:
|
|
46
|
+
- Static HTML/CSS/JS
|
|
47
|
+
- React starter
|
|
51
48
|
|
|
52
|
-
|
|
49
|
+
## Templates
|
|
53
50
|
|
|
54
|
-
|
|
51
|
+
### 1. Static HTML/CSS/JS
|
|
55
52
|
|
|
56
|
-
|
|
53
|
+
Creates a simple static site starter.
|
|
54
|
+
|
|
55
|
+
Generated structure:
|
|
56
|
+
|
|
57
|
+
```text
|
|
57
58
|
my-awesome-app/
|
|
58
59
|
├── index.html
|
|
59
60
|
├── css/
|
|
@@ -62,45 +63,70 @@ my-awesome-app/
|
|
|
62
63
|
└── app.js
|
|
63
64
|
```
|
|
64
65
|
|
|
65
|
-
|
|
66
|
+
### 2. React starter (Vite)
|
|
66
67
|
|
|
67
|
-
|
|
68
|
-
- ⬆️⬇️ **Arrow Key Navigation** - Easy project type selection with arrow keys
|
|
69
|
-
- 📁 **Template-Based** - Pre-built, production-ready project templates
|
|
70
|
-
- ⚡ **Instant Setup** - Scaffold complete projects in seconds
|
|
71
|
-
- 📦 **Lightweight** - Minimal dependencies and fast installation
|
|
72
|
-
- 🧩 **Extensible** - Easy to add custom project templates
|
|
68
|
+
Creates a React starter app with Vite and automatically runs npm install.
|
|
73
69
|
|
|
74
|
-
|
|
70
|
+
Generated structure:
|
|
75
71
|
|
|
76
|
-
|
|
72
|
+
```text
|
|
73
|
+
my-awesome-app/
|
|
74
|
+
├── package.json
|
|
75
|
+
├── public/
|
|
76
|
+
│ ├── index.html
|
|
77
|
+
│ └── index.css
|
|
78
|
+
└── src/
|
|
79
|
+
├── App.css
|
|
80
|
+
├── App.jsx
|
|
81
|
+
├── index.css
|
|
82
|
+
└── main.jsx
|
|
83
|
+
```
|
|
77
84
|
|
|
78
|
-
|
|
85
|
+
After scaffolding a React project:
|
|
79
86
|
|
|
87
|
+
```bash
|
|
88
|
+
cd my-awesome-app
|
|
89
|
+
npm run dev
|
|
80
90
|
```
|
|
91
|
+
|
|
92
|
+
## Features
|
|
93
|
+
|
|
94
|
+
- Interactive CLI powered by @inquirer/prompts
|
|
95
|
+
- Fast project scaffolding from local templates
|
|
96
|
+
- Two starter options: static web or React + Vite
|
|
97
|
+
- Automatic dependency installation for React template
|
|
98
|
+
- Simple command interface via ct-pro
|
|
99
|
+
|
|
100
|
+
## Project Structure
|
|
101
|
+
|
|
102
|
+
```text
|
|
81
103
|
quick-scaffolds-cli/
|
|
82
104
|
├── bin/
|
|
83
|
-
│ └── cli.js
|
|
84
|
-
├── templates/
|
|
85
|
-
│
|
|
86
|
-
│
|
|
87
|
-
│
|
|
88
|
-
│
|
|
89
|
-
│
|
|
90
|
-
│
|
|
105
|
+
│ └── cli.js
|
|
106
|
+
├── templates/
|
|
107
|
+
│ ├── html-template/
|
|
108
|
+
│ │ ├── index.html
|
|
109
|
+
│ │ ├── css/
|
|
110
|
+
│ │ │ └── style.css
|
|
111
|
+
│ │ └── js/
|
|
112
|
+
│ │ └── app.js
|
|
113
|
+
│ └── react-template/
|
|
114
|
+
│ ├── package.json
|
|
115
|
+
│ ├── public/
|
|
116
|
+
│ │ ├── index.css
|
|
117
|
+
│ │ └── index.html
|
|
118
|
+
│ └── src/
|
|
119
|
+
│ ├── App.css
|
|
120
|
+
│ ├── App.jsx
|
|
121
|
+
│ ├── index.css
|
|
122
|
+
│ └── main.jsx
|
|
91
123
|
├── package.json
|
|
92
124
|
└── README.md
|
|
93
125
|
```
|
|
94
126
|
|
|
95
127
|
## Dependencies
|
|
96
128
|
|
|
97
|
-
-
|
|
98
|
-
- **inquirer** (^13.3.2) - Command-line interface utilities
|
|
99
|
-
|
|
100
|
-
## Version History
|
|
101
|
-
|
|
102
|
-
- **v1.1.0** - Improved interactive selection with arrow key navigation, organized template structure
|
|
103
|
-
- **v1.0.0** - Initial release with basic scaffolding functionality
|
|
129
|
+
- @inquirer/prompts ^8.3.2
|
|
104
130
|
|
|
105
131
|
## License
|
|
106
132
|
|
|
@@ -108,4 +134,4 @@ MIT
|
|
|
108
134
|
|
|
109
135
|
## Contributing
|
|
110
136
|
|
|
111
|
-
|
|
137
|
+
Issues and pull requests are welcome on github.
|