You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+50-3Lines changed: 50 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ Since this package is not yet published to NPM, here is how to play with the sou
60
60
cd objectui
61
61
pnpm install
62
62
# Build the core engine
63
-
pnpm build
63
+
pnpm build
64
64
```
65
65
66
66
2. **Run the ObjectStack Console**
@@ -72,7 +72,17 @@ Since this package is not yet published to NPM, here is how to play with the sou
72
72
# Opens http://localhost:5173
73
73
```
74
74
75
-
3. **Edit & Reload**
75
+
3. **Try the Minimal Console Example** (New!)
76
+
77
+
See how to integrate ObjectUI in your own app:
78
+
79
+
```bash
80
+
cd examples/minimal-console
81
+
pnpm dev
82
+
# Opens http://localhost:5174
83
+
```
84
+
85
+
4. **Edit & Reload**
76
86
77
87
Edit the JSON schema files and the changes will be instantly reflected in the browser.
78
88
@@ -84,6 +94,7 @@ ObjectStack examples that demonstrate different features and use cases:
84
94
- **[examples/todo](examples/todo)** - Simple task management app demonstrating basic ObjectStack configuration and field types.
85
95
- **[examples/kitchen-sink](examples/kitchen-sink)** - Comprehensive component catalog showing all available field types, dashboard widgets, and view types.
86
96
- **[examples/msw-todo](examples/msw-todo)** - Frontend-first development example using MSW (Mock Service Worker) to run ObjectStack in the browser.
97
+
- **[examples/minimal-console](examples/minimal-console)** ⭐ **NEW!** - Minimal custom console in~100 lines showing third-party integration without full console infrastructure. Uses `@object-ui/app-shell` and `@object-ui/providers` with custom routing and mock API.
87
98
88
99
### Running Examples as API Servers
89
100
@@ -107,12 +118,48 @@ Each server provides:
107
118
108
119
## 📦 For React Developers
109
120
110
-
Install the core packages to use `<SchemaRenderer>` inside your Next.js or Vite app.
121
+
### Option 1: Full Console (ObjectStack Backend)
122
+
123
+
Install the core packages to use `<SchemaRenderer>` inside your Next.js or Vite app with ObjectStack backend:
0 commit comments