Skip to content

Latest commit

 

History

History

README.md

ObjectStack Example Server

This is a reference implementation of the ObjectStack Server Protocol (Kernel). It demonstrates how to build a metadata-driven backend that dynamically loads object definitions from plugins and automatically generates REST APIs.

Features

  • Dynamic Schema Loading: Loads crm and todo apps as plugins.
  • Unified Metadata API: /api/v1/meta/objects
  • Unified Data API: /api/v1/data/:object (CRUD)
  • Zero-Code Backend: No creating routes or controllers per object.

Setup

  1. Make sure all dependencies are installed in the workspace root:

    pnpm install
  2. Run the server:

    npm run dev

API Usage Examples

1. Get All Objects

curl http://localhost:3000/api/v1/meta/objects

2. Create a Todo

curl -X POST http://localhost:3000/api/v1/data/todo_task \
  -H "Content-Type: application/json" \
  -d '{"title": "Buy Milk", "priority": "high"}'

3. List Todos

curl http://localhost:3000/api/v1/data/todo_task