Skip to content

Commit b9464e8

Browse files
Copilothotlong
andcommitted
Update documentation to reference new JSON examples
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 0dddf0e commit b9464e8

File tree

2 files changed

+69
-5
lines changed

2 files changed

+69
-5
lines changed

docs/CLI_GUIDE.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,62 @@ You can also define navigation in your main schema using button click handlers:
388388

389389
**Note:** Layout support with `app.json` and `_layout.json` is planned for a future release. Currently, all routing is handled at the page level.
390390

391+
## Running Example Projects
392+
393+
The Object UI repository includes ready-to-use examples that demonstrate various UI patterns and features. You can run them directly using the CLI:
394+
395+
### Available Examples
396+
397+
1. **Basic Form** - Contact form with validation
398+
```bash
399+
objectui serve examples/basic-form/app.json
400+
```
401+
402+
2. **Dashboard** - Analytics dashboard with metrics and activity feeds
403+
```bash
404+
objectui serve examples/dashboard/app.json
405+
```
406+
407+
3. **Data Display** - User profiles, task lists, progress bars, and badges
408+
```bash
409+
objectui serve examples/data-display/app.json
410+
```
411+
412+
4. **Landing Page** - Complete marketing page with hero section and CTAs
413+
```bash
414+
objectui serve examples/landing-page/app.json
415+
```
416+
417+
5. **CLI Demo** - Bilingual form demonstration
418+
```bash
419+
objectui serve examples/cli-demo/app.schema.json
420+
```
421+
422+
### Exploring Examples
423+
424+
Each example includes:
425+
- `app.json` - The JSON schema definition
426+
- `README.md` - Detailed documentation and customization guide
427+
- `.gitignore` - Git ignore configuration
428+
429+
To explore an example:
430+
431+
```bash
432+
# Clone the repository
433+
git clone https://github.com/objectql/objectui.git
434+
cd objectui/examples
435+
436+
# View available examples
437+
ls -la
438+
439+
# Run an example
440+
objectui serve basic-form/app.json
441+
```
442+
443+
Then open http://localhost:3000 in your browser and start editing the `app.json` file to see live updates!
444+
445+
For more details, see the [Examples README](https://github.com/objectql/objectui/tree/main/examples).
446+
391447
## FAQ
392448

393449
### 1. How to customize styles?

docs/guide/quick-start.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -179,11 +179,19 @@ Now that you have the basics:
179179

180180
## Examples
181181

182-
Check out complete examples:
183-
184-
- [Form Example](https://github.com/objectql/objectui/tree/main/examples/forms)
185-
- [CRUD Example](https://github.com/objectql/objectui/tree/main/examples/crud)
186-
- [Dashboard Example](https://github.com/objectql/objectui/tree/main/examples/dashboard)
182+
Check out our JSON-based examples that you can run immediately:
183+
184+
- [Basic Form](https://github.com/objectql/objectui/tree/main/examples/basic-form) - Contact form with validation
185+
- [Dashboard](https://github.com/objectql/objectui/tree/main/examples/dashboard) - Analytics dashboard with metrics
186+
- [Data Display](https://github.com/objectql/objectui/tree/main/examples/data-display) - Lists, badges, and progress bars
187+
- [Landing Page](https://github.com/objectql/objectui/tree/main/examples/landing-page) - Complete marketing page
188+
- [All Examples](https://github.com/objectql/objectui/tree/main/examples) - View the full collection
189+
190+
Run any example with the CLI:
191+
```bash
192+
npm install -g @object-ui/cli
193+
objectui serve examples/basic-form/app.json
194+
```
187195

188196
## Need Help?
189197

0 commit comments

Comments
 (0)