@gravito/pulse 1.0.0-alpha.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 +81 -0
- package/bin/gravito.mjs +2 -0
- package/dist/index.js +5120 -0
- package/dist/src/index.js +5098 -0
- package/package.json +40 -0
- package/stubs/controller.stub +10 -0
- package/stubs/middleware.stub +6 -0
- package/stubs/migration.stub +19 -0
- package/stubs/model.stub +10 -0
- package/stubs/seeder.stub +11 -0
- package/stubs/tinker-bootstrap.ts +26 -0
package/README.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Orbit Pulse (CLI)
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Orbit Pulse
|
|
6
|
+
|
|
7
|
+
The official CLI for scaffolding and managing Gravito projects.
|
|
8
|
+
|
|
9
|
+
Gravito CLI provides a comprehensive suite of tools to help you build, test, and manage your application, offering an experience similar to Laravel Artisan.
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# Global install (recommended)
|
|
15
|
+
bun add -g @gravito/pulse
|
|
16
|
+
|
|
17
|
+
# Or use npx/bunx
|
|
18
|
+
bunx @gravito/pulse create my-app
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
### Create a New Project
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
# Interactive mode (recommended)
|
|
27
|
+
gravito create [project-name]
|
|
28
|
+
|
|
29
|
+
# Quick create with template
|
|
30
|
+
gravito create my-app --template basic
|
|
31
|
+
gravito create my-app --template inertia-react
|
|
32
|
+
gravito create my-app --template static-site
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
When using the `static-site` template, you'll be prompted to choose between React or Vue 3 for the frontend framework.
|
|
36
|
+
|
|
37
|
+
### Scaffolding (Make Commands)
|
|
38
|
+
|
|
39
|
+
Generate code quickly using standard templates:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
# Create a Controller
|
|
43
|
+
gravito make:controller UserController
|
|
44
|
+
|
|
45
|
+
# Create a Middleware
|
|
46
|
+
gravito make:middleware EnsureAdmin
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Development Utilities
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# List all registered routes
|
|
53
|
+
gravito route:list
|
|
54
|
+
|
|
55
|
+
# Start interactive Tinker REPL (with core & container preloaded)
|
|
56
|
+
gravito tinker
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
> **Note**: Database management commands (`migrate`, `db:seed`, etc.) and scheduler commands (`schedule:*`) are not available in v1.0. These features will be introduced in future releases.
|
|
60
|
+
|
|
61
|
+
## Available Templates
|
|
62
|
+
|
|
63
|
+
| Template | Description |
|
|
64
|
+
|----------|-------------|
|
|
65
|
+
| `basic` | Minimal setup with PlanetCore + Gravito Core. Great for APIs and simple backends. |
|
|
66
|
+
| `inertia-react` | Full-stack monolith with Inertia.js + React + Vite. Build modern SPAs with server-side routing. |
|
|
67
|
+
| `static-site` | Pre-configured static site generator for GitHub Pages, Vercel, Netlify. Supports React or Vue 3. Perfect for documentation sites, blogs, and marketing pages. |
|
|
68
|
+
|
|
69
|
+
## Development
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
# Run locally
|
|
73
|
+
bun run dev create my-test-app
|
|
74
|
+
|
|
75
|
+
# Build binary
|
|
76
|
+
bun run build
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## License
|
|
80
|
+
|
|
81
|
+
MIT © [Carl Lee](https://github.com/gravito-framework/gravito)
|
package/bin/gravito.mjs
ADDED