Skip to content

ido4-dev/ido4-demo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ido4-demo — Notification Platform API

Demo codebase for ido4 governance. A TypeScript notification platform API that's ~40% complete — designed to be governed by ido4's sandbox system.

Purpose

This codebase serves as the governed project in ido4's sandbox demonstrations. It provides:

  • Real code that ido4's decomposition pipeline can analyze
  • Real dependency chains that ido4's BRE (Business Rule Engine) enforces
  • Real stubs that AI agents can implement under governance
  • A strategic spec that feeds ido4's spec-to-task pipeline

One codebase, three methodologies — Hydro, Scrum, or Shape Up governance via ido4 profiles.

Module Status

Module Completion Description
shared/ 100% Error hierarchy, logger, config, validation (Zod)
auth/ 100% User management, JWT, API keys, RBAC
notifications/ 50% Event model + bus complete; delivery engine + retry = stubs
templates/ 40% Engine + store complete; renderer = stub
channels/ 10% Registry + types complete; 4 provider stubs (email, SMS, push, webhook)
api/ 30% Auth routes complete; notifications + rate limiter = stubs
analytics/ 0% Planned — see strategic spec
integrations/ 0% Planned — see strategic spec

Quick Start

npm install
npm run build
npm test

Usage with ido4

  1. Clone this repo alongside ido4-MCP
  2. Create a sandbox: create_sandbox with the repo path
  3. Run /ido4:decompose against specs/notification-platform.md
  4. Agents work on governed tasks against this codebase

Strategic Spec

See specs/notification-platform.md — 16 capabilities across 6 groups, in ido4shape format. NCO-01 (Delivery Engine) is the critical path; 10 capabilities depend on it.

Reset

Restore to starting state for sandbox replay:

bash sandbox/reset.sh

Architecture

src/
├── shared/          Foundation: errors, logger, config, validation
├── auth/            COMPLETE: users, JWT, API keys, RBAC
├── notifications/   PARTIAL: event model + bus done, delivery engine stub
├── templates/       PARTIAL: engine + store done, renderer stub
├── channels/        INTERFACES: registry done, 4 provider stubs
├── analytics/       PLANNED: see strategic spec
├── integrations/    PLANNED: see strategic spec
└── api/             PARTIAL: auth routes done, notifications stub

Tech Stack

  • TypeScript (ES2022, strict mode)
  • Express (HTTP layer)
  • Zod (validation)
  • jsonwebtoken (JWT)
  • Vitest (testing)

License

MIT

About

Notification Platform API — demo codebase for ido4 governance

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors