The main repository for inGitDB — an open-source versioned database that stores data in text files (JSON, YAML, columnar storage) with Git-based version control.

This repo is the central hub for project planning, issue tracking, architecture documentation, and AI agent prompts across the entire inGitDB ecosystem.

inGitDB is a Git-backed versioned database designed for teams who want to manage structured data with the same workflows they use for code.

• 🔀 Version Control — full history, branching, and merging of data changes
• 👥 Collaboration — multiple users work on data using Git-native workflows (PRs, reviews, branches)
• 📝 Text-Based Storage — JSON, YAML, and columnar formats that are human-readable and Git-diffable
• ✅ Validation — schema validation and referential integrity checks via CLI and GitHub Actions
• 📊 Reference Data — ideal for configuration, reference tables, and slowly-changing data

┌─────────────────────────────────────────────────────┐
│                   GitHub Actions                     │
│              (Validation & CI/CD)                    │
└─────────────────────────────────────────────────────┘
                         ▲
                         │ Uses
                         │
┌────────────────┐   ┌───▼──────────────┐   ┌─────────────────┐
│  ingitdb-ts    │◄──┤  ingitdb-server  │───┤   ingitdb-go    │
│  (TS Client)   │   │   (REST API)     │   │   (Go CLI/Lib)  │
└────────────────┘   └──────────────────┘   └─────────────────┘
                              │
                              ▼
                     ┌────────────────┐
                     │   Git Storage  │
                     │ (JSON/YAML/CSV)│
                     └────────────────┘

💡 Collections vs Tables: Unlike traditional database tables where records are flat rows, a collection item can itself contain sub-collections — enabling naturally hierarchical data structures without joins or foreign keys.

Repository	Description	Status
ingitdb (this repo)	Main hub — planning, issues, AI prompts, documentation	Active
ingitdb-go	Go CLI & library — core validation, data management, server (serve command)
ingitdb-ts	TypeScript client library for inGitDB	Active
ingitdb-schema	JSON Schema definitions for inGitDB databases	Active

This repository doesn't contain application source code. Instead, it serves as the project hub:

ingitdb/
├── README.md                              ← You are here
├── AGENTS.md                              ← AI agent guidelines (all agents)
├── CLAUDE.md                              ← Claude Code configuration
├── LICENSE                                ← CC0 1.0 Universal
├── docs/                                  ← Planning & architecture documents
│   ├── dev-plan/                          ←   Skills matrix, agents, execution plan
│   ├── open-api/                          ←   OpenAPI spec & REST API reference
│   ├── ingitdb-ts-architecture.md         ←   TypeScript client architecture
│   ├── github-actions-integration.md      ←   CI/CD workflows & actions
│   └── summary.md                         ←   Deliverable status & next steps
└── ai/
    └── prompts/                           ← 10 AI development task prompts

JSON Schema definitions for inGitDB configuration and collection files are available in the ingitdb-schema repository:

These schemas are derived from the Go struct definitions in ingitdb-go. See the ingitdb-schema README for full property documentation.

1. Review the Execution Plan — timeline and milestones
2. Check the Skills Matrix — team requirements
3. Skim Risk Management — known risks and mitigations
4. Track progress via Summary

1. Browse the Architecture Documentation
2. Reference the OpenAPI Spec for the REST API contract
3. Follow Technology Stack recommendations
4. Use AI Prompts for guided development tasks

1. Start with AGENTS.md for complete guidelines
2. Find your role and deliverables
3. Pick your prompt and follow acceptance criteria

npx @openapitools/openapi-generator-cli generate \
  -i docs/openapi-spec.yaml \
  -g nodejs-express-server \
  -o ./ingitdb-server

npx @openapitools/openapi-generator-cli generate \
  -i docs/openapi-spec.yaml \
  -g typescript-axios \
  -o ./ingitdb-ts/src/generated

See the full Development Plan for details.

Contributions are welcome! This repo is best for:

• Planning proposals — open an issue or PR to discuss architecture changes
• Documentation improvements — fix typos, add guides, improve clarity
• Issue tracking — report bugs or request features across the ecosystem

For code contributions to implementations:

• 🌐 inGitDB Organization
• 📖 inGitDB Documentation
• 🛠️ ingitdb-go CLI

CC0 1.0 Universal — see LICENSE for details. Implementation repositories are licensed under MIT.