Update project tracker example and API reference UI

hotlong · hotlong · commit d045de5d24fe · 2026-01-16T00:28:40.000+08:00
Added development and contributing instructions to README. Changed project tracker example to use 'objectql serve' for starting the API server and moved the seed script to a separate file. Updated the API reference UI in the CLI serve command to use Scalar instead of Swagger UI.
diff --git a/README.md b/README.md
@@ -260,6 +260,44 @@ For a complete status report on ObjectQL's implementation against the documented
 
 ---
 
+## 🛠️ Development & Contributing
+
+If you fork or clone the repository to contribute or run examples from source:
+
+1. **Setup Workspace**
+   ```bash
+   git clone https://github.com/objectql/objectql.git
+   cd objectql
+   npm install -g pnpm
+   pnpm install
+   ```
+
+2. **Build Packages**
+   You must build the core libraries before running examples, as they rely on local workspace builds.
+   ```bash
+   pnpm build
+   ```
+
+3. **Run Examples**
+   
+   These examples run as **scripts** to demonstrate the ObjectQL Core Engine capabilities (Validation, CRUD, Logic Hooks). They use an in-memory SQLite database.
+
+   **Starter (Project Tracker):**
+   ```bash
+   # Starts the API Server (http://localhost:3000)
+   pnpm --filter @objectql/example-project-tracker start
+   
+   # Note: Sample data (projects.data.yml) is automatically loaded on startup
+   ```
+
+   **Enterprise ERP:**
+   ```bash
+   pnpm --filter @objectql/example-enterprise-erp start
+   # Output: Plugin initialization, Employee creation logs, Audit trails
+   ```
+
+---
+
 ## ⚖️ License
 
 ObjectQL is open-source software licensed under the [MIT License](https://www.google.com/search?q=LICENSE).
diff --git a/examples/showcase/project-tracker/package.json b/examples/showcase/project-tracker/package.json
@@ -24,7 +24,8 @@
     "dist"
   ],
   "scripts": {
-    "start": "ts-node src/index.ts",
+    "start": "objectql serve --dir src",
+    "seed": "ts-node src/seed.ts",
     "codegen": "objectql generate -s src -o src/types",
     "build": "npm run codegen && tsc && rsync -a --include '*/' --include '*.yml' --exclude '*' src/ dist/",
     "repl": "objectql repl",
diff --git a/examples/showcase/project-tracker/src/seed.ts b/examples/showcase/project-tracker/src/seed.ts
diff --git a/packages/tools/cli/src/commands/serve.ts b/packages/tools/cli/src/commands/serve.ts
@@ -9,28 +9,24 @@ import chalk from 'chalk';
 
 const CONSOLE_HTML = `
 <!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="utf-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1" />
-  <title>ObjectQL Swagger UI</title>
-  <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@5.11.0/swagger-ui.css" />
-  <style>
-    body { margin: 0; padding: 0; }
-  </style>
-</head>
-<body>
-<div id="swagger-ui"></div>
-<script src="https://unpkg.com/swagger-ui-dist@5.11.0/swagger-ui-bundle.js" crossorigin></script>
-<script>
-  window.onload = () => {
-    window.ui = SwaggerUIBundle({
-      url: '/openapi.json',
-      dom_id: '#swagger-ui',
-    });
-  };
-</script>
-</body>
+<html>
+  <head>
+    <title>ObjectQL API Reference (Scalar)</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style>
+      body { margin: 0; }
+    </style>
+  </head>
+  <body>
+    <script
+      id="api-reference"
+      data-url="/openapi.json"
+      data-proxy-url="https://proxy.scalar.com"
+      data-configuration='{"theme": "deepSpace"}'
+    ></script>
+    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
+  </body>
 </html>
 `;
 
