rapidkit 0.14.1 → 0.14.2
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 +40 -9
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,11 +5,13 @@
|
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
6
|
[](https://github.com/getrapidkit/rapidkit-npm/stargazers)
|
|
7
7
|
|
|
8
|
-
> ⚠️ **
|
|
9
|
-
>
|
|
8
|
+
> ⚠️ **PREVIEW VERSION** - This package provides demo templates for testing RapidKit's workflow.
|
|
9
|
+
> Full module ecosystem and advanced features will be available after the Python Core release.
|
|
10
10
|
|
|
11
11
|
🚀 The easiest way to create FastAPI and NestJS projects with RapidKit templates!
|
|
12
12
|
|
|
13
|
+
> 🔮 **Coming Soon:** AI-powered module recommendations when Core modules are released!
|
|
14
|
+
|
|
13
15
|
**💡 Tip:** Use the [RapidKit VS Code Extension](https://marketplace.visualstudio.com/items?itemName=rapidkit.rapidkit-vscode) for a visual interface!
|
|
14
16
|
|
|
15
17
|
## Quick Start
|
|
@@ -60,10 +62,12 @@ npx rapidkit admin-api --template nestjs # Create NestJS project
|
|
|
60
62
|
|
|
61
63
|
## Templates
|
|
62
64
|
|
|
63
|
-
| Template
|
|
64
|
-
|
|
65
|
-
| `fastapi` | FastAPI
|
|
66
|
-
| `nestjs`
|
|
65
|
+
| Template | Framework | Description |
|
|
66
|
+
| --------- | --------- | ------------------------------------------------------ |
|
|
67
|
+
| `fastapi` | FastAPI | Python async web framework with automatic API docs |
|
|
68
|
+
| `nestjs` | NestJS | TypeScript Node.js framework with modular architecture |
|
|
69
|
+
|
|
70
|
+
> 📦 **Note:** These templates are designed for testing the RapidKit workflow. Full module ecosystem coming with Core release!
|
|
67
71
|
|
|
68
72
|
## CLI Options
|
|
69
73
|
|
|
@@ -72,11 +76,13 @@ npx rapidkit [project-name] [options]
|
|
|
72
76
|
```
|
|
73
77
|
|
|
74
78
|
### Arguments
|
|
79
|
+
|
|
75
80
|
- `project-name` - Name of project/workspace directory to create
|
|
76
81
|
|
|
77
82
|
### Options
|
|
83
|
+
|
|
78
84
|
- `-t, --template <template>` - Template to use: `fastapi` or `nestjs` (creates direct project)
|
|
79
|
-
- `--skip-git` - Skip git initialization
|
|
85
|
+
- `--skip-git` - Skip git initialization
|
|
80
86
|
- `--skip-install` - Skip installing dependencies (for NestJS)
|
|
81
87
|
- `--debug` - Enable verbose debug logging
|
|
82
88
|
- `--dry-run` - Preview what would be created without creating it
|
|
@@ -158,9 +164,34 @@ my-api/
|
|
|
158
164
|
|
|
159
165
|
## Requirements
|
|
160
166
|
|
|
161
|
-
- **Node.js**:
|
|
162
|
-
- **For FastAPI**: Python 3.
|
|
167
|
+
- **Node.js**: 20.19.6+ (LTS recommended)
|
|
168
|
+
- **For FastAPI**: Python 3.10.14+ with Poetry 2.2.1+
|
|
163
169
|
- **For NestJS**: Node.js 20+ with npm/yarn/pnpm
|
|
170
|
+
- **Git**: For version control
|
|
171
|
+
|
|
172
|
+
> 💡 **Tip:** Use [RapidKit VS Code Extension](https://marketplace.visualstudio.com/items?itemName=rapidkit.rapidkit-vscode) - includes system checker to verify all requirements!
|
|
173
|
+
|
|
174
|
+
## What's Next?
|
|
175
|
+
|
|
176
|
+
This npm package is currently in **preview mode** with demo templates. Here's what's coming:
|
|
177
|
+
|
|
178
|
+
### 🚀 After Core Release (v1.0.0)
|
|
179
|
+
|
|
180
|
+
- **Full Module Ecosystem** - 50+ production-ready modules
|
|
181
|
+
- **AI-Powered Recommendations** - Intelligent module suggestions
|
|
182
|
+
- **Seamless Integration** - npm package becomes thin wrapper over Python Core
|
|
183
|
+
- **Dynamic Modules** - Install any module from the registry
|
|
184
|
+
- **Advanced Features** - All RapidKit power through npm
|
|
185
|
+
|
|
186
|
+
### 📦 Current Focus (v0.15.0)
|
|
187
|
+
|
|
188
|
+
- Polish existing features
|
|
189
|
+
- Improve documentation
|
|
190
|
+
- Optimize bundle size
|
|
191
|
+
- Prepare Core integration bridge
|
|
192
|
+
- Enhanced error messages
|
|
193
|
+
|
|
194
|
+
**Stay tuned!** Follow our progress on [GitHub](https://github.com/getrapidkit/rapidkit-npm).
|
|
164
195
|
|
|
165
196
|
## Development
|
|
166
197
|
|
package/dist/package.json
CHANGED