Skip to content

Add CLI tool for building and serving apps from JSON/YAML schemas with file-system routing #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
huangyiirene merged 13 commits into from
Jan 15, 2026
Merged

Add CLI tool for building and serving apps from JSON/YAML schemas with file-system routing #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
6634d55
Initial plan
Copilot Jan 14, 2026
4fc8c18
Add CLI package with init and serve commands
Copilot Jan 14, 2026
cf77876
Add Chinese language support and CLI documentation
Copilot Jan 14, 2026
d675467
Add CLI demo example with bilingual interface
Copilot Jan 15, 2026
91f6899
Simplify CLI to work in standalone mode only
Copilot Jan 15, 2026
90d6ce4
Add comprehensive CLI implementation summary
Copilot Jan 15, 2026
30de3ed
Fix duplicate Tailwind directives in CLI serve command
Copilot Jan 15, 2026
2d52763
Convert CLI documentation to English-only and add routing guide
Copilot Jan 15, 2026
cd26724
Add Next.js-style file-system routing documentation to CLI guide
Copilot Jan 15, 2026
009dbae
Implement file-system based routing (Next.js-style) for CLI
Copilot Jan 15, 2026
2f67510
Changes before error encountered
Copilot Jan 15, 2026
ae8b77f
Simplify file extensions to .json/.yml/.yaml for future extensibility
Copilot Jan 15, 2026
bd214c4
Remove Chinese text and update all references to use app.json instead…
Copilot Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ Thumbs.db
# VitePress build output
docs/.vitepress/dist
docs/.vitepress/cache

# Object UI CLI temporary files
.objectui-tmp
29 changes: 27 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,31 @@ const schema = {

## Quick Start

### Installation
### Option 1: Using CLI (Fastest Way) 🚀

The easiest way to get started is using the Object UI CLI:

```bash
# Install the CLI globally
npm install -g @object-ui/cli

# Create a new app from JSON schema
objectui init my-app

# Start the development server
cd my-app
objectui serve app.schema.json
```

Your app will be running at http://localhost:3000! 🎉

Just edit `app.schema.json` to build your UI - no React code needed.

[📖 CLI Documentation](./docs/CLI_GUIDE.md) | [🇨🇳 中文文档](./docs/CLI_GUIDE.md#chinese)

### Option 2: Using as a Library

#### Installation

```bash
# Using npm
Expand All @@ -120,7 +144,7 @@ yarn add @object-ui/react @object-ui/components
pnpm add @object-ui/react @object-ui/components
```

### Basic Usage
#### Basic Usage

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

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