Merge pull request #392 from objectstack-ai/copilot/start-examples-api-service

Author: hotlong

README.md

@@ -78,9 +78,32 @@ Since this package is not yet published to NPM, here is how to play with the sou
 
 ## Examples
 
-- [examples/crm](examples/crm) - CRM metadata app with a custom server.
-- [examples/kitchen-sink](examples/kitchen-sink) - Component catalog metadata app.
-- [examples/objectstack-server](examples/objectstack-server) - Run a metadata app with @objectstack/cli.
+ObjectStack examples that demonstrate different features and use cases:
+
+- **[examples/crm](examples/crm)** - Full-featured CRM application with dashboards, multiple views (Grid, Kanban, Map, Gantt), and custom server implementation.
+- **[examples/todo](examples/todo)** - Simple task management app demonstrating basic ObjectStack configuration and field types.
+- **[examples/kitchen-sink](examples/kitchen-sink)** - Comprehensive component catalog showing all available field types, dashboard widgets, and view types.
+- **[examples/msw-todo](examples/msw-todo)** - Frontend-first development example using MSW (Mock Service Worker) to run ObjectStack in the browser.
+
+### Running Examples as API Servers
+
+All examples (except msw-todo) can be run as API servers using `@objectstack/cli`:
+
+```bash
+# From the monorepo root
+pnpm run serve:crm          # Start CRM example on http://localhost:3000
+pnpm run serve:todo         # Start Todo example on http://localhost:3000
+pnpm run serve:kitchen-sink # Start Kitchen Sink example on http://localhost:3000
+
+# Or from individual example directories
+cd examples/crm
+pnpm run serve
+```
+
+Each server provides:
+- GraphQL API endpoint: `http://localhost:3000/graphql`
+- REST API endpoints based on object definitions
+- Sample data loaded from the configuration manifest
 
 ## 📦 For React Developers
 

examples/kitchen-sink/package.json

@@ -10,6 +10,7 @@
     "./objectstack.config": "./objectstack.config.ts"
   },
   "scripts": {
+    "serve": "objectstack serve objectstack.config.ts",
     "build": "objectstack compile objectstack.config.ts dist/objectstack.json"
   },
   "dependencies": {

examples/todo/README.md

@@ -46,17 +46,33 @@ examples/todo/
 
 ## 💡 Usage
 
-This package is part of the `examples` workspace. To build and verify:
+This package is part of the `examples` workspace. You can build it, run it as an API server, or just use it for reference.
+
+### Running as API Server
+
+```bash
+# From the monorepo root
+pnpm run serve:todo
+
+# Or from this directory
+pnpm run serve
+```
+
+The server will start on `http://localhost:3000` providing:
+- GraphQL API endpoint: `http://localhost:3000/graphql`
+- REST API endpoints based on the object definitions
+
+### Building the Example
 
 ```bash
 # Install dependencies (from monorepo root)
 pnpm install
 
 # Build the example
-pnpm --filter @objectstack/example-todo build
+pnpm --filter @object-ui/example-todo build
 
 # Run type checking
-pnpm --filter @objectstack/example-todo typecheck
+pnpm --filter @object-ui/example-todo typecheck
 ```
 
 ## 📖 Learning Path

examples/todo/package.json

@@ -8,6 +8,7 @@
     "./objectstack.config": "./objectstack.config.ts"
   },
   "scripts": {
+    "serve": "objectstack serve objectstack.config.ts",
     "build": "objectstack compile objectstack.config.ts dist/objectstack.json"
   },
   "dependencies": {

package.json

@@ -17,6 +17,9 @@
   ],
   "scripts": {
     "dev:crm": "pnpm --filter @object-ui/example-crm start",
+    "serve:crm": "pnpm --filter @object-ui/example-crm serve",
+    "serve:todo": "pnpm --filter @object-ui/example-todo serve",
+    "serve:kitchen-sink": "pnpm --filter @object-ui/example-kitchen-sink serve",
     "build": "turbo run build --filter=!@object-ui/site",
     "build:all": "turbo run build",
     "test": "vitest run",