🌱 beeping-meta

Architecture, ADRs, Terraform IaC, governance, brand kit and legal docs for the Beeping Platform.

---

🧩 What is this repo?

beeping-meta is the single source of truth for everything that doesn't belong in any individual product repo of the Beeping Platform:

• 🏗️ Architecture — C4 diagrams, sequence diagrams, system context
• 📜 ADRs — Architecture Decision Records (Michael Nygard format)
• 🏗️ Terraform IaC — All infrastructure as code (GCP, Firebase, Cloudflare DNS)
• 📜 Legal — Terms, privacy, DPA, AUP, security policy, sub-processors list
• 🎨 Brand — Logo, palette, typography, design tokens
• 📊 Data governance — Telemetry schema whitelist, PII redaction rules
• 📘 Runbooks — Operational runbooks, incident response, DR
• 🤖 Reusable workflows — GitHub Actions workflows shared across all 18 repos
• 📊 Compatibility matrix — Cross-repo version compatibility tracking

It also serves as the technical home for cross-repo coordination of the Beeping ecosystem.

🌐 The 18-repo ecosystem

beeping-meta is one of 18 repositories that make up the Beeping Platform. See the organization profile for the full ecosystem map.

Category	Repo
🌱 Foundation (this repo)	beeping-meta
🧱 Core lib	beeping-core (C++)
📡 Service	beepbox (C++ HTTP server)
📱 Mobile native	beeping-android, beeping-ios
🔌 Cross-platform	beeping_flutter, beeping-react-native
🌐 Web monorepo	beeping-web (@beeping/web, @beeping/react, @beeping/vue, @beeping/svelte, @beeping/vanilla)
⚙️ Server SDKs	beeping-node, beeping-python
🛠️ Tools	beeping-cli (Rust)
☁️ Cloud	beeping-backend (Firebase Functions), beeping-portal (Next.js dev console)
🌐 Public sites	beeping-www (marketing), beeping-docs (Astro Starlight)
📲 Reference apps	beeply (Flutter), beeply-rn (React Native), beeply-web (Next.js + React)

📁 Directory structure

beeping-meta/
├── architecture/      → C4 diagrams + sequence diagrams (Phase 0 BEE-8)
├── decisions/         → ADRs (Phase 0 BEE-7)
├── terraform/         → IaC for GCP + Firebase + Cloudflare (Phase 0 BEE-14)
│   ├── gcp/
│   ├── firebase/
│   ├── cloudflare/
│   └── modules/
├── legal/             → Terms, privacy, DPA, AUP (Phase 0 BEE-13)
├── brand/             → Logo, palette, typography, tokens (Phase 0 BEE-12)
├── data-governance/   → Telemetry schema, PII redaction whitelist
├── runbooks/          → Incident response, DR playbooks
├── scripts/           → Helper scripts
├── .github/
│   ├── workflows/     → Reusable workflows shared across the ecosystem (Phase 0 BEE-10)
│   ├── ISSUE_TEMPLATE/
│   └── PULL_REQUEST_TEMPLATE.md
├── compatibility.md    → Cross-repo version matrix (Phase 0 BEE-9)
├── MEMORY.md           → Operational notebook
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
└── VERSION

🚧 Status

Early development. Most directories contain placeholder READMEs with the task ID that will populate them.

Track progress in the Beeping Platform Linear project (read-only after launch).

🔗 Quick links

• 📋 Decisions index — All ADRs
• 🏗️ Architecture — C4 diagrams + sequences
• 🏗️ Terraform — IaC entry point
• 📜 Legal — Terms, privacy, DPA
• 🎨 Brand kit — Logo, palette, tokens
• 📊 Data governance — Telemetry schema, redaction
• 📘 Runbooks — Incident response
• 🤝 Contributing
• 🛡️ Security
• 📊 Compatibility matrix

🛠️ Local setup

git clone https://github.com/beeping-io/beeping-meta.git
cd beeping-meta
lefthook install
bash scripts/smoke-test.sh

🤝 Contributing

See CONTRIBUTING.md. Conventional Commits enforced via commitlint.

🛡️ Security

See SECURITY.md. Vulnerabilities → security@beeping.io (do not open public issues).

📜 License

Apache License 2.0.