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
{{ message }}
Repository navigation
Commit c11be8a
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: ui/README.md
+4-55Lines changed: 4 additions & 55 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,8 +56,6 @@ Pick the path that matches where you are starting from:
56
56
| You want to… | Start here | Install |
57
57
|---|---|---|
58
58
| Render a JSON schema inside your React app |[`examples/hello-world`](examples/hello-world)|`@object-ui/react @object-ui/components`|
59
-
| Embed views in an existing app, against **your own** backend |[`examples/byo-backend-console`](examples/byo-backend-console)|`@object-ui/app-shell @object-ui/plugin-view @object-ui/react`|
60
-
| Stand up a complete console on an **ObjectStack** backend |[`examples/console-starter`](examples/console-starter)| fork the example |
61
59
| Build a UI from a JSON file, no React code at all |[`@object-ui/cli`](packages/cli)|`npm install -g @object-ui/cli`|
62
60
63
61
The [examples catalog](examples/README.md) explains each one in more depth.
@@ -115,47 +113,6 @@ it is handed to the component the schema names — so a value passed as `data={
115
113
read nor refused, and the expression that wanted it is returned as its own source text, with
116
114
nothing thrown and one line on the console.
117
115
118
-
### Bring your own backend
119
-
120
-
Use the shell and views without the full console infrastructure — your routing, your auth, your API:
[`examples/byo-backend-console`](examples/byo-backend-console) is the complete working version, with a mock REST adapter.
158
-
159
116
### No React at all
160
117
161
118
```bash
@@ -167,18 +124,10 @@ objectui dev app.json # dev server on http://localhost:3000
167
124
168
125
Edit `app.json` to build your UI.
169
126
170
-
### Run the examples from this repo
171
-
172
-
```bash
173
-
pnpm run setup # builds @objectstack/* at .objectstack-sha, then installs
174
-
pnpm -w build
175
-
176
-
cd examples/console-starter # or examples/byo-backend-console
177
-
pnpm dev
178
-
```
127
+
### The examples in this repo
179
128
180
-
`hello-world`ships no dev server: copy its `App.tsx` and`schema.json` into your own
181
-
Vite/Next.js app. `schema-catalog` is a data package — the canonical JSON schemas the
129
+
Neither example ships a dev server. `hello-world`is a snippet: copy its `App.tsx` and
130
+
`schema.json` into your own Vite/Next.js app. `schema-catalog` is a data package — the canonical JSON schemas the
182
131
docs render, a smoke test mounts, and AI agents use as a few-shot corpus.
183
132
184
133
## Copy-Paste Schemas
@@ -378,7 +327,7 @@ Grouped by dependency weight — atoms and fields stay light, heavy widgets live
378
327
379
328
| Package | Description |
380
329
|---------|-------------|
381
-
|**[@object-ui/app-shell](./packages/app-shell)**|Minimal application shell — the base of every console|
330
+
|**[@object-ui/app-shell](./packages/app-shell)**|The Console's shell, views and Studio; a private workspace package since 18.2, no longer published to npm|
382
331
|**[@object-ui/providers](./packages/providers)**| The upload adapter context the file and image fields upload through |
383
332
|**[@object-ui/auth](./packages/auth)**|`AuthProvider`, `useAuth`, `AuthGuard`, sign-in forms |
384
333
|**[@object-ui/permissions](./packages/permissions)**| Object / field / row-level permission guards and hooks |
Copy file name to clipboardExpand all lines: ui/examples/README.md
+5-19Lines changed: 5 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,10 @@ Runnable examples that show how to consume ObjectUI in different scenarios. Pick
7
7
| Example | Use it when… | Backend | Bundle | What it gives you |
8
8
|---|---|---|---|---|
9
9
|[`hello-world/`](./hello-world)| You want the smallest possible `<SchemaRenderer>` demo to see the JSON → React pipeline. | None (in-memory schema) | Tiny | A single `App.tsx` rendering one schema. |
10
-
|[`byo-backend-console/`](./byo-backend-console)| You want to **embed** ObjectUI into your own app and connect it to **your own** REST/GraphQL backend. | Bring-your-own (mock REST shown) |~50 KB |`@object-ui/app-shell` + `@object-ui/react`, custom router, custom `DataSource`. ~100 lines of integration code, no auth, no plugins. |
11
-
|[`console-starter/`](./console-starter)| You want a **fork-ready, opinionated console** with the full plugin set already wired against an **ObjectStack** backend. | ObjectStack (`/api/v1`) | Full |`@object-ui/app-shell``ConsoleShell` + `AuthProvider` + every `@object-ui/plugin-*` (grid, kanban, calendar, charts, dashboard, designer, detail, form, list, report, view, chatbot). |
12
10
13
-
> **Rule of thumb:**
14
-
> - Learning the rendering protocol → `hello-world`.
15
-
> - Adding ObjectUI to an existing product / different backend → `byo-backend-console`.
16
-
> - Standing up a brand-new ObjectStack console → fork `console-starter`.
11
+
> The console itself is `apps/console`, built for ObjectOS. `@object-ui/app-shell`, the
12
+
> package its shell and views live in, is private and no longer published to npm, so there
13
+
> is no host-console example to fork.
17
14
18
15
### Also under `examples/`
19
16
@@ -23,18 +20,7 @@ Runnable examples that show how to consume ObjectUI in different scenarios. Pick
23
20
24
21
## Running an example
25
22
26
-
`byo-backend-console` and `console-starter` are Vite apps. From the monorepo root:
27
-
28
-
```bash
29
-
pnpm install
30
-
pnpm -w build
31
-
cd examples/console-starter # or byo-backend-console
32
-
pnpm dev
33
-
```
34
-
35
-
Each exposes its own dev server port (see its README).
36
-
37
-
The other two directories are not dev servers: `hello-world` is a snippet to drop into
23
+
Neither directory is a dev server: `hello-world` is a snippet to drop into
38
24
your own Vite/Next.js app, and `schema-catalog` is a data package verified with
Copy file name to clipboardExpand all lines: ui/examples/hello-world/README.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,4 @@ pnpm install
28
28
29
29
## Learn more
30
30
31
-
-[BYO Backend Console](../byo-backend-console/) — add ObjectUI to an existing product with your own REST/GraphQL backend (~100 lines: custom `DataSource` + router)
32
-
-[Console Starter](../console-starter/) — fork it to stand up a brand-new ObjectStack console, with the full plugin set already wired
33
31
-[Schema Catalog](../schema-catalog/) — canonical JSON schemas used across docs & tests
Copy file name to clipboardExpand all lines: ui/packages/app-shell/README.md
+9-15Lines changed: 9 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,12 @@
1
1
# @object-ui/app-shell
2
2
3
-
**Minimal Application Shell for ObjectUI**
3
+
**The ObjectOS Console's shell, views and Studio — a private workspace package**
4
4
5
-
A lightweight, framework-agnostic rendering engine that enables third-party systems to integrate ObjectUI components without inheriting the full console infrastructure.
5
+
> **Not published since 18.2.** This package exists to serve the ObjectOS Console
6
+
> (`apps/console`), and a customisable console for a third-party host has no business
7
+
> demand today, so it is `private: true` and no longer released to npm. The last published
8
+
> version is 18.1.x, which the maintainer deprecates on npm after 18.2. Inside this
9
+
> workspace `apps/console` and the `@object-ui/*` packages keep importing it as before.
6
10
7
11
## Purpose
8
12
@@ -15,9 +19,8 @@ This package provides the essential building blocks for rendering ObjectUI schem
15
19
16
20
## Installation
17
21
18
-
```bash
19
-
pnpm add @object-ui/app-shell
20
-
```
22
+
There is nothing to install from npm: the package is private (see above). Workspace
23
+
consumers declare it as `"@object-ui/app-shell": "workspace:*"`.
21
24
22
25
## Requires a bundler — plain Node cannot import this package
23
26
@@ -196,7 +199,7 @@ reads as off, so a self-hosted admin's page load issues no request and logs no
196
199
## Default auth pages and the sign-up offer
197
200
198
201
`DefaultLoginPage` and `DefaultRegisterPage` are the sign-in and sign-up pages
199
-
a host mounts at `/login` and `/register` (`examples/console-starter` does).
202
+
a host mounts at `/login` and `/register` (`apps/console` mounts its own pages there).
200
203
They offer a generic sign-up only where the server would accept one. The
201
204
server states that rule in two keys of `GET /api/v1/auth/config`:
202
205
`emailPassword.disableSignUp` (the hard off switch) and
@@ -1096,15 +1099,6 @@ Third-Party App
1096
1099
| Data Source | Any | ObjectStack |
1097
1100
| Customization | Full control | Limited |
1098
1101
1099
-
## Examples
1100
-
1101
-
See `examples/byo-backend-console` for a complete working example that demonstrates:
1102
-
- Custom routing with React Router
1103
-
- Custom data adapter (not ObjectStack)
1104
-
- Custom authentication
1105
-
- Cherry-picking only needed components
1106
-
- Building a console in ~100 lines of code
1107
-
1108
1102
## Record create/edit modes
1109
1103
1110
1104
The default `<DefaultAppContent>` shell mounts a global `<ModalForm>` for
0 commit comments