Add hello-world starter example with zero-config setup and inline schema

Author: hotlong

README.md

@@ -46,57 +46,54 @@ ObjectQL is organized as a Monorepo to ensure modularity and universal compatibi
 ### 1. Installation
 
 ```bash
-# Install core and a driver (e.g., Postgres)
-npm install @objectql/core @objectql/driver-sql pg
-
+# Install core and a driver (e.g., Postgres or SQLite)
+npm install @objectql/core @objectql/driver-sql sqlite3
 ```
 
-### 2. Define Schema (The "Object")
+### 2. The Universal Script
 
-Create a simple definition object (or load it from a `.yml` file).
-
-```typescript
-const UserObject = {
-  name: "users",
-  fields: {
-    name: { type: "text", required: true },
-    email: { type: "email", unique: true },
-    role: { 
-      type: "select", 
-      options: ["admin", "user"], 
-      default: "user" 
-    }
-  }
-};
-
-```
-
-### 3. Initialize & Query
-
-ObjectQL provides a unified API regardless of the underlying database.
+ObjectQL can run in a single file without complex configuration.
 
 ```typescript
 import { ObjectQL } from '@objectql/core';
 import { SqlDriver } from '@objectql/driver-sql';
 
 async function main() {
-  // 1. Initialize Engine
-  const objectql = new ObjectQL();
-  
-  // 2. Register Driver
+  // 1. Initialize Driver (In-Memory SQLite)
   const driver = new SqlDriver({
-    connection: process.env.DATABASE_URL
+    client: 'sqlite3',
+    connection: { filename: ':memory:' }, 
+    useNullAsDefault: true
   });
-  objectql.registerDriver(driver);
 
-  // 3. Register Object
-  objectql.register(UserObject);
+  // 2. Initialize Engine
+  const app = new ObjectQL({
+    datasources: { default: driver }
+  });
+
+  // 3. Define Schema (The "Object")
+  // In a real app, this would be loaded from a .yml file
+  app.registerObject({
+    name: "users",
+    fields: {
+      name: { type: "text", required: true },
+      email: { type: "email", unique: true },
+      role: { 
+        type: "select", 
+        options: ["admin", "user"], 
+        defaultValue: "user" 
+      }
+    }
+  });
+
+  await app.init();
 
   // 4. Enjoy Type-Safe(ish) CRUD
-  const repo = objectql.getRepository('users');
+  const ctx = app.createContext({ isSystem: true });
+  const repo = ctx.object('users');
 
   // Create
-  await repo.insert({ name: 'Alice', email: 'alice@example.com' });
+  await repo.create({ name: 'Alice', email: 'alice@example.com' });
 
   // Find
   const users = await repo.find({
@@ -107,7 +104,6 @@ async function main() {
 }
 
 main();
-
 ```
 
 ---
@@ -176,5 +172,3 @@ You can use it freely in personal, commercial, or open-source projects.
 
 <sub><b>ObjectQL (Data)</b> • <a href="https://github.com/objectql/objectos">ObjectOS (System)</a> • <a href="https://github.com/objectql/objectui">Object UI (View)</a></sub>
 </div>
-
-```

docs/guide/getting-started.md

@@ -20,33 +20,67 @@ npm install @objectql/core @objectql/driver-mongo mongodb
 
 ## Quick Start: The "Hello World"
 
-Let's build a simple **To-Do List** backend.
+You can experience ObjectQL with a single file. No YAML, no complex config.
 
-### 1. Define Your Object
+### 1. Minimal Setup
 
-In ObjectQL, everything is an "Object" (like a Table or Collection).
+Install the core and SQLite driver (for zero-config database).
 
-**ObjectQL uses filename-based identification** - the object name is automatically inferred from the filename, making your metadata files cleaner.
+```bash
+npm install @objectql/core @objectql/driver-sql sqlite3
+# or
+pnpm add @objectql/core @objectql/driver-sql sqlite3
+```
 
-```yaml
-# File: todo.object.yml
-# Object name "todo" is automatically inferred from filename!
+### 2. The Universal Script
 
-label: To-Do Item
-fields:
-  title:
-    type: text
-    label: Task Name
-  completed:
-    type: boolean
-    default: false
-```
+Create `index.ts`. This script defines the schema, boots the engine, and runs queries in one go.
+
+```typescript
+import { ObjectQL } from '@objectql/core';
+import { SqlDriver } from '@objectql/driver-sql';
+
+async function main() {
+  // 1. Initialize Driver (In-Memory SQLite)
+  const driver = new SqlDriver({
+    client: 'sqlite3',
+    connection: { filename: ':memory:' }, 
+    useNullAsDefault: true
+  });
+
+  // 2. Initialize Engine
+  const app = new ObjectQL({
+    datasources: { default: driver }
+  });
+
+  // 3. Define Metadata Inline (Code as Configuration)
+  app.registerObject({
+    name: 'todo',
+    fields: {
+      title: { type: 'text', required: true },
+      completed: { type: 'boolean', defaultValue: false }
+    }
+  });
+
+  await app.init();
+
+  // 4. Run Business Logic
+  // We use a system context here for simplicity
+  const ctx = app.createContext({ isSystem: true });
+  const repo = ctx.object('todo');
 
-**Note:** You no longer need to specify `name: todo` - it's inferred from the filename `todo.object.yml`!
+  await repo.create({ title: 'Build the Future' });
+  
+  const results = await repo.find();
+  console.log('Todos:', results);
+}
+
+main();
+```
 
-### 2. Configure the Engine
+## Scaling Up: The Metadata Approach
 
-Updated in v0.2: You can now use a simple connection string.
+Once you are comfortable with the core, you should move your definitions to YAML files.
 
 ```typescript
 import { ObjectQL } from '@objectql/core';

examples/graphql-api/README.md

@@ -0,0 +1,29 @@
+# Hello ObjectQL
+
+This is the simplest possible example of **ObjectQL**.
+
+It demonstrates:
+1.  **Zero Config:** No YAML files or server setup required.
+2.  **In-Memory SQL:** Uses SQLite in memory, so no database installation is needed.
+3.  **Inline Schema:** Defines the data model directly in code.
+
+## How to Run
+
+Since you are in the monorepo, simply run:
+
+```bash
+# Install dependencies (if not already done at root)
+pnpm install
+
+# Run the script
+cd examples/starters/hello-world
+pnpm start
+```
+
+## What you see
+
+The script will:
+1.  Initialize the ObjectQL engine.
+2.  Create a `deal` object definition on the fly.
+3.  Insert a record into the in-memory SQLite database.
+4.  Query it back and print the result.

examples/starters/hello-world/README.md

@@ -0,0 +1,53 @@
+import { ObjectQL } from '@objectql/core';
+import { SqlDriver } from '@objectql/driver-sql';
+
+async function main() {
+  console.log("🚀 Starting ObjectQL Hello World...");
+
+  // 1. Initialize Driver
+  const driver = new SqlDriver({
+    client: 'sqlite3',
+    connection: { filename: ':memory:' }, 
+    useNullAsDefault: true
+  });
+
+  // 2. Initialize Engine (Pass driver in config)
+  const app = new ObjectQL({
+    datasources: {
+        default: driver
+    }
+  });
+  
+  // 3. Define Metadata Inline
+  app.registerObject({
+    name: 'deal',
+    fields: {
+      title: { type: 'text', required: true },
+      amount: { type: 'currency', scale: 2 },
+      stage: { 
+        type: 'select', 
+        options: ['new', 'negotiation', 'closed'],
+        defaultValue: 'new'
+      }
+    }
+  });
+
+  await app.init(); // Boot the engine
+
+  // 4. Run Business Logic
+  // We create a system context to bypass permission checks for this simple script
+  const ctx = app.createContext({ isSystem: true });
+  const repo = ctx.object('deal');
+  
+  console.log("Creating a new Deal...");
+  await repo.create({ 
+    title: 'Enterprise Contract', 
+    amount: 50000, 
+    stage: 'new' 
+  });
+  
+  const results = await repo.find({});
+  console.log('✅ Deals found in database:', results); 
+}
+
+main().catch(console.error);

examples/starters/hello-world/index.ts

@@ -0,0 +1,19 @@
+{
+  "name": "@example/hello-world",
+  "version": "1.0.0",
+  "private": true,
+  "description": "Zero-config ObjectQL starter",
+  "scripts": {
+    "start": "tsx index.ts"
+  },
+  "dependencies": {
+    "@objectql/core": "workspace:*",
+    "@objectql/driver-sql": "workspace:*",
+    "sqlite3": "^5.1.7"
+  },
+  "devDependencies": {
+    "tsx": "^4.7.1",
+    "typescript": "^5.3.3",
+    "@types/node": "^20.11.24"
+  }
+}

examples/starters/hello-world/package.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "Start",
+    "moduleResolution": "node",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  }
+}