@mvp-kit/create 0.0.10 → 0.0.12
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 +50 -19
- package/dist/create.js +861 -569
- package/dist/create.js.map +1 -1
- package/dist/download.js +75 -0
- package/dist/download.js.map +1 -0
- package/dist/index.js +24 -42
- package/dist/index.js.map +1 -1
- package/dist/template.js +75 -156
- package/dist/template.js.map +1 -1
- package/dist/utils.js +0 -88
- package/dist/utils.js.map +1 -1
- package/package.json +21 -21
- package/dist/database.js +0 -105
- package/dist/database.js.map +0 -1
- package/dist/template-downloader.js +0 -248
- package/dist/template-downloader.js.map +0 -1
- package/dist/test.js +0 -359
- package/dist/test.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @mvp-kit/create
|
|
2
2
|
|
|
3
|
-
> The official CLI for creating MVPKit applications
|
|
3
|
+
> The official Create CLI for creating MVPKit applications
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@mvp-kit/create)
|
|
6
6
|
[](https://opensource.org/licenses/MIT)
|
|
@@ -16,12 +16,11 @@ pnpm create @mvp-kit my-app
|
|
|
16
16
|
|
|
17
17
|
# Or with bun
|
|
18
18
|
bun create @mvp-kit my-app
|
|
19
|
-
|
|
20
19
|
```
|
|
21
20
|
|
|
22
21
|
## Features
|
|
23
22
|
|
|
24
|
-
|
|
23
|
+
🧱 **MVPKit Core Template**
|
|
25
24
|
- React 19 with modern concurrent features
|
|
26
25
|
- Cloudflare Workers for edge computing
|
|
27
26
|
- tRPC for end-to-end type safety
|
|
@@ -29,60 +28,92 @@ bun create @mvp-kit my-app
|
|
|
29
28
|
- Better Auth for authentication
|
|
30
29
|
- Tailwind CSS + shadcn/ui components
|
|
31
30
|
|
|
31
|
+
🚀 **MVPKit SaaS Template**
|
|
32
|
+
- Everything in Core, plus SaaS-oriented modules and structure
|
|
33
|
+
- Advanced product surface scaffolding across `apps/web` and `apps/app`
|
|
34
|
+
- Expanded package layout for larger production applications
|
|
35
|
+
|
|
32
36
|
## Usage
|
|
33
37
|
|
|
34
38
|
### Basic Commands
|
|
35
39
|
|
|
36
40
|
```bash
|
|
37
|
-
# Create a new MVPKit core
|
|
41
|
+
# Create a new MVPKit application (interactive, defaults to core)
|
|
38
42
|
npx @mvp-kit/create my-app
|
|
39
43
|
|
|
40
|
-
#
|
|
41
|
-
npx @mvp-kit/create my-app --
|
|
44
|
+
# Create from SaaS template
|
|
45
|
+
npx @mvp-kit/create my-app --template saas
|
|
42
46
|
|
|
43
47
|
# Non-interactive mode (use defaults)
|
|
44
|
-
npx @mvp-kit/create my-app --
|
|
48
|
+
npx @mvp-kit/create my-app --yes
|
|
49
|
+
|
|
50
|
+
# Skip dependency installation
|
|
51
|
+
npx @mvp-kit/create my-app --no-install
|
|
45
52
|
```
|
|
46
53
|
|
|
47
54
|
### Options
|
|
48
55
|
|
|
49
56
|
| Option | Description |
|
|
50
57
|
|--------|-------------|
|
|
51
|
-
|
|
|
52
|
-
|
|
|
58
|
+
| `-t, --template <template>` | Template to use (`core`, `saas`; default: `core`) |
|
|
59
|
+
| `-d, --description <text>` | Project description |
|
|
60
|
+
| `-w, --website <domain>` | Domain name for the application |
|
|
61
|
+
| `-p, --pack <pack>` | Component pack to install |
|
|
62
|
+
| `--no-cache` | Disable template caching |
|
|
53
63
|
| `--no-install` | Skip dependency installation |
|
|
54
64
|
| `--no-git` | Skip git initialization |
|
|
55
|
-
|
|
|
56
|
-
| `--no-interactive` | Skip interactive mode (use defaults) |
|
|
65
|
+
| `-y, --yes` | Skip interactive prompts and use defaults |
|
|
57
66
|
|
|
58
67
|
### Examples
|
|
59
68
|
|
|
60
69
|
```bash
|
|
61
|
-
# Minimal setup (skip installs)
|
|
70
|
+
# Minimal setup (skip installs and git)
|
|
62
71
|
npx @mvp-kit/create my-app --no-install --no-git
|
|
63
72
|
|
|
64
|
-
# Quick setup with
|
|
65
|
-
npx @mvp-kit/create my-app --
|
|
73
|
+
# Quick setup with all components
|
|
74
|
+
npx @mvp-kit/create my-app --pack all
|
|
66
75
|
|
|
67
76
|
# Non-interactive with custom options
|
|
68
77
|
npx @mvp-kit/create my-app \
|
|
69
78
|
--description "My awesome app" \
|
|
70
|
-
--
|
|
71
|
-
--
|
|
79
|
+
--website "myapp.com" \
|
|
80
|
+
--yes
|
|
72
81
|
```
|
|
73
82
|
|
|
74
83
|
## What You Get
|
|
75
84
|
|
|
85
|
+
### 🚀 Automated Setup
|
|
86
|
+
The CLI automatically handles:
|
|
87
|
+
- **Database Setup**: Initializes D1 database, generates schema, and runs migrations
|
|
88
|
+
- **Dependencies**: Installs all required packages
|
|
89
|
+
- **UI Components**: Configures shadcn/ui with your chosen theme
|
|
90
|
+
- **Code Quality**: Sets up ESLint, Prettier, and TypeScript
|
|
91
|
+
- **Version Control**: Initializes git repository with initial commit
|
|
92
|
+
|
|
76
93
|
### 🆓 MVPKit Core Template
|
|
77
94
|
Production-ready foundation for rapid development:
|
|
78
95
|
- **Frontend**: React 19, TanStack Router, TanStack Query
|
|
79
96
|
- **Backend**: Cloudflare Workers, Hono, tRPC
|
|
80
|
-
- **Database**: D1 with Drizzle ORM
|
|
97
|
+
- **Database**: D1 with Drizzle ORM (auto-configured)
|
|
81
98
|
- **Auth**: Better Auth with social providers
|
|
82
99
|
- **Styling**: Tailwind CSS v4 + shadcn/ui
|
|
83
100
|
- **Deployment**: Cloudflare Pages + Workers
|
|
84
101
|
|
|
85
|
-
|
|
102
|
+
### 🚀 MVPKit SaaS Template
|
|
103
|
+
Advanced continuation of Core for product teams:
|
|
104
|
+
- **Everything in Core**, plus expanded SaaS-oriented scaffolding
|
|
105
|
+
- **Larger app surface** for authenticated and marketing experiences
|
|
106
|
+
- **Production structure** tuned for iterative feature growth
|
|
107
|
+
|
|
108
|
+
### 📱 Development Workflow
|
|
109
|
+
```bash
|
|
110
|
+
cd my-app
|
|
111
|
+
pnpm dev
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Application endpoints:
|
|
115
|
+
- `http://localhost:3001` (web)
|
|
116
|
+
- `http://localhost:3002` (app)
|
|
86
117
|
|
|
87
118
|
## Development
|
|
88
119
|
|
|
@@ -113,4 +144,4 @@ See [CLI_TESTING_GUIDE.md](./CLI_TESTING_GUIDE.md) for detailed development inst
|
|
|
113
144
|
|
|
114
145
|
## License
|
|
115
146
|
|
|
116
|
-
MIT © [MVPKit](https://mvpkit.dev)
|
|
147
|
+
MIT © [MVPKit](https://mvpkit.dev)
|