stackkit 0.2.7 → 0.2.8
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 +87 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,34 +1,109 @@
|
|
|
1
1
|
# StackKit CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Production-ready full-stack project generator.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Installation
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
No installation required. Use npx to get the latest version:
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
+
npx stackkit@latest <command>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Commands
|
|
14
|
+
|
|
15
|
+
### create
|
|
16
|
+
|
|
17
|
+
Generate a new project:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# Interactive mode
|
|
10
21
|
npx stackkit@latest create my-app
|
|
22
|
+
|
|
23
|
+
# With options
|
|
24
|
+
npx stackkit@latest create my-app \
|
|
25
|
+
--framework nextjs \
|
|
26
|
+
--database prisma-postgresql \
|
|
27
|
+
--auth better-auth \
|
|
28
|
+
--language typescript
|
|
11
29
|
```
|
|
12
30
|
|
|
13
|
-
|
|
31
|
+
**Options:**
|
|
32
|
+
- `--framework, -f` - nextjs, express, react
|
|
33
|
+
- `--database, -d` - prisma-postgresql, prisma-mysql, prisma-sqlite, prisma-mongodb, mongoose, none
|
|
34
|
+
- `--auth, -a` - better-auth, authjs, none
|
|
35
|
+
- `--language, -l` - typescript, javascript
|
|
36
|
+
- `--package-manager, -p` - pnpm, npm, yarn, bun
|
|
37
|
+
- `--yes, -y` - Use defaults
|
|
38
|
+
- `--skip-install` - Don't install dependencies
|
|
39
|
+
- `--no-git` - Don't initialize git
|
|
40
|
+
|
|
41
|
+
### add
|
|
42
|
+
|
|
43
|
+
Add features to existing project:
|
|
14
44
|
|
|
15
45
|
```bash
|
|
16
|
-
npx stackkit@latest add
|
|
46
|
+
npx stackkit@latest add
|
|
17
47
|
```
|
|
18
48
|
|
|
19
|
-
|
|
49
|
+
Interactively select and install modules.
|
|
50
|
+
|
|
51
|
+
### doctor
|
|
52
|
+
|
|
53
|
+
Diagnose project health:
|
|
20
54
|
|
|
21
55
|
```bash
|
|
22
56
|
npx stackkit@latest doctor
|
|
57
|
+
|
|
58
|
+
# Verbose output
|
|
59
|
+
npx stackkit@latest doctor --verbose
|
|
60
|
+
|
|
61
|
+
# JSON output (for CI/CD)
|
|
62
|
+
npx stackkit@latest doctor --json
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### list
|
|
66
|
+
|
|
67
|
+
Show available options:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx stackkit@latest list
|
|
23
71
|
```
|
|
24
72
|
|
|
25
|
-
## Supported
|
|
73
|
+
## Supported Technologies
|
|
74
|
+
|
|
75
|
+
**Frameworks:**
|
|
76
|
+
- Next.js (App Router)
|
|
77
|
+
- Express (TypeScript API)
|
|
78
|
+
- React (Vite SPA)
|
|
79
|
+
|
|
80
|
+
**Databases:**
|
|
81
|
+
- Prisma (PostgreSQL, MySQL, SQLite, MongoDB)
|
|
82
|
+
- Mongoose (MongoDB)
|
|
83
|
+
|
|
84
|
+
**Authentication:**
|
|
85
|
+
- Better Auth (All frameworks)
|
|
86
|
+
- Auth.js (Next.js only)
|
|
26
87
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
88
|
+
## Examples
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
# Full-stack Next.js
|
|
92
|
+
npx stackkit@latest create my-app --framework nextjs --database prisma-postgresql --auth better-auth
|
|
93
|
+
|
|
94
|
+
# Express API
|
|
95
|
+
npx stackkit@latest create my-api --framework express --database mongoose
|
|
96
|
+
|
|
97
|
+
# React frontend
|
|
98
|
+
npx stackkit@latest create my-spa --framework react --auth better-auth
|
|
99
|
+
```
|
|
30
100
|
|
|
31
101
|
## Links
|
|
32
102
|
|
|
33
|
-
-
|
|
34
|
-
-
|
|
103
|
+
- **Documentation**: https://stackkit.tariqul.dev
|
|
104
|
+
- **GitHub**: https://github.com/tariqul420/stackkit
|
|
105
|
+
- **Issues**: https://github.com/tariqul420/stackkit/issues
|
|
106
|
+
|
|
107
|
+
## License
|
|
108
|
+
|
|
109
|
+
MIT © [Tariqul Islam](https://github.com/tariqul420)
|