@beknurakhmed/webforge-cli 0.1.0 → 0.1.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 +38 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,24 +1,28 @@
|
|
|
1
|
-
# webforge-cli
|
|
1
|
+
# @beknurakhmed/webforge-cli
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@beknurakhmed/webforge-cli)
|
|
4
|
+
[](https://github.com/beknurakhmed/webforge-cli/blob/main/LICENSE)
|
|
5
|
+
[](https://nodejs.org)
|
|
2
6
|
|
|
3
7
|
Interactive CLI to generate production-ready website project templates. Pick your template, framework, styling, state management, and coding paradigm — get a fully configured project in seconds.
|
|
4
8
|
|
|
5
9
|
## Quick Start
|
|
6
10
|
|
|
7
11
|
```bash
|
|
8
|
-
npx webforge-cli
|
|
12
|
+
npx @beknurakhmed/webforge-cli
|
|
9
13
|
```
|
|
10
14
|
|
|
11
15
|
Or install globally:
|
|
12
16
|
|
|
13
17
|
```bash
|
|
14
|
-
npm install -g webforge-cli
|
|
18
|
+
npm install -g @beknurakhmed/webforge-cli
|
|
15
19
|
webforge-cli
|
|
16
20
|
```
|
|
17
21
|
|
|
18
22
|
You can also pass the project name directly:
|
|
19
23
|
|
|
20
24
|
```bash
|
|
21
|
-
npx webforge-cli my-app
|
|
25
|
+
npx @beknurakhmed/webforge-cli my-app
|
|
22
26
|
```
|
|
23
27
|
|
|
24
28
|
## How It Works
|
|
@@ -26,21 +30,24 @@ npx webforge-cli my-app
|
|
|
26
30
|
The CLI walks you through an interactive wizard:
|
|
27
31
|
|
|
28
32
|
```
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
npm
|
|
33
|
+
┌ webforge-cli — project template generator
|
|
34
|
+
│
|
|
35
|
+
◆ Project name: → my-awesome-app
|
|
36
|
+
◆ Select a template: → Landing Page / E-commerce / CRM / Dashboard / Blog / Portfolio
|
|
37
|
+
◆ Select a framework: → React / Vue / Angular / Vanilla / Next.js / Nuxt
|
|
38
|
+
◆ Coding paradigm: → Functional / SOLID OOP
|
|
39
|
+
◆ Styling solution: → Tailwind CSS / SCSS / CSS Modules / Material UI / ...
|
|
40
|
+
◆ State management: → Redux / Zustand / MobX / Pinia / NgRx / RxJS / None
|
|
41
|
+
◆ Extra tools: → TypeScript / ESLint / Prettier
|
|
42
|
+
│
|
|
43
|
+
◇ Project generated successfully!
|
|
44
|
+
│
|
|
45
|
+
│ Next steps:
|
|
46
|
+
│ cd my-awesome-app
|
|
47
|
+
│ npm install
|
|
48
|
+
│ npm run dev
|
|
49
|
+
│
|
|
50
|
+
└ Happy coding!
|
|
44
51
|
```
|
|
45
52
|
|
|
46
53
|
## Template Types
|
|
@@ -101,7 +108,7 @@ Choose between two coding styles for your generated project:
|
|
|
101
108
|
### React + Landing Page + Tailwind
|
|
102
109
|
|
|
103
110
|
```bash
|
|
104
|
-
npx webforge-cli
|
|
111
|
+
npx @beknurakhmed/webforge-cli
|
|
105
112
|
# → my-landing
|
|
106
113
|
# → Landing Page
|
|
107
114
|
# → React
|
|
@@ -114,7 +121,7 @@ npx webforge-cli
|
|
|
114
121
|
### Vue + E-commerce + SCSS + Pinia
|
|
115
122
|
|
|
116
123
|
```bash
|
|
117
|
-
npx webforge-cli
|
|
124
|
+
npx @beknurakhmed/webforge-cli
|
|
118
125
|
# → my-store
|
|
119
126
|
# → E-commerce
|
|
120
127
|
# → Vue
|
|
@@ -127,7 +134,7 @@ npx webforge-cli
|
|
|
127
134
|
### Angular + Dashboard + Angular Material + NgRx
|
|
128
135
|
|
|
129
136
|
```bash
|
|
130
|
-
npx webforge-cli
|
|
137
|
+
npx @beknurakhmed/webforge-cli
|
|
131
138
|
# → admin-panel
|
|
132
139
|
# → Dashboard
|
|
133
140
|
# → Angular
|
|
@@ -205,8 +212,15 @@ node dist/index.js
|
|
|
205
212
|
|
|
206
213
|
## Contributing
|
|
207
214
|
|
|
208
|
-
Contributions are welcome!
|
|
215
|
+
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for Git Flow branching strategy and guidelines.
|
|
216
|
+
|
|
217
|
+
## Author
|
|
218
|
+
|
|
219
|
+
**Beknur** — Frontend Developer & Software Engineer
|
|
220
|
+
|
|
221
|
+
- GitHub: [@beknurakhmed](https://github.com/beknurakhmed)
|
|
222
|
+
- npm: [@beknurakhmed](https://www.npmjs.com/~beknurakhmed)
|
|
209
223
|
|
|
210
224
|
## License
|
|
211
225
|
|
|
212
|
-
MIT
|
|
226
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@beknurakhmed/webforge-cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Interactive CLI to generate website project templates — landing pages, e-commerce, CRM, dashboards, blogs, portfolios with React, Vue, Angular, Next.js, Nuxt and more",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|