Skip to content

Commit a6ca2f0

Browse files
authored
Merge pull request #47 from objectstack-ai/copilot/create-app-with-json
2 parents 34c697e + bd214c4 commit a6ca2f0

File tree

17 files changed

+3197
-5
lines changed

17 files changed

+3197
-5
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,6 @@ Thumbs.db
4040
# VitePress build output
4141
docs/.vitepress/dist
4242
docs/.vitepress/cache
43+
44+
# Object UI CLI temporary files
45+
.objectui-tmp

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,31 @@ const schema = {
107107

108108
## Quick Start
109109

110-
### Installation
110+
### Option 1: Using CLI (Fastest Way) 🚀
111+
112+
The easiest way to get started is using the Object UI CLI:
113+
114+
```bash
115+
# Install the CLI globally
116+
npm install -g @object-ui/cli
117+
118+
# Create a new app from JSON schema
119+
objectui init my-app
120+
121+
# Start the development server
122+
cd my-app
123+
objectui serve app.schema.json
124+
```
125+
126+
Your app will be running at http://localhost:3000! 🎉
127+
128+
Just edit `app.schema.json` to build your UI - no React code needed.
129+
130+
[📖 CLI Documentation](./docs/CLI_GUIDE.md) | [🇨🇳 中文文档](./docs/CLI_GUIDE.md#chinese)
131+
132+
### Option 2: Using as a Library
133+
134+
#### Installation
111135

112136
```bash
113137
# Using npm
@@ -120,7 +144,7 @@ yarn add @object-ui/react @object-ui/components
120144
pnpm add @object-ui/react @object-ui/components
121145
```
122146

123-
### Basic Usage
147+
#### Basic Usage
124148

125149
```tsx
126150
import React from 'react'
@@ -167,6 +191,7 @@ Object UI is a modular monorepo with packages designed for specific use cases:
167191

168192
| Package | Description | Size |
169193
|---------|-------------|------|
194+
| **[@object-ui/cli](./packages/cli)** | CLI tool for building apps from JSON schemas | 25KB |
170195
| **[@object-ui/types](./packages/types)** | TypeScript definitions and protocol specs | 10KB |
171196
| **[@object-ui/core](./packages/core)** | Core logic, validation, registry (Zero React) | 20KB |
172197
| **[@object-ui/react](./packages/react)** | React bindings and `SchemaRenderer` | 15KB |

0 commit comments

Comments
 (0)