An open API service indexing awesome lists of open source software.

https://github.com/beeping-io/beeping-meta

🌱 Architecture, ADRs, Terraform IaC, governance, brand kit and legal docs for the Beeping Platform
https://github.com/beeping-io/beeping-meta

adr architecture beeping governance meta open-source terraform

Last synced: about 2 months ago
JSON representation

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

Awesome Lists containing this project

README

          

# 🌱 beeping-meta

> **Architecture, ADRs, Terraform IaC, governance, brand kit and legal docs for the [Beeping Platform](https://beeping.io).**

[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Status: Early Development](https://img.shields.io/badge/status-early_development-orange)](https://linear.app/beeping/project/beeping-platform-03da887d924e)
[![Beeping Platform](https://img.shields.io/badge/platform-Beeping-7C3AED)](https://beeping.io)
[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

---

## 🧩 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](https://github.com/beeping-io) 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

```text
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](https://linear.app/beeping/project/beeping-platform-03da887d924e) (read-only after launch).

## 🔗 Quick links

- 📋 [Decisions index](decisions/README.md) — All ADRs
- 🏗️ [Architecture](architecture/README.md) — C4 diagrams + sequences
- 🏗️ [Terraform](terraform/README.md) — IaC entry point
- 📜 [Legal](legal/README.md) — Terms, privacy, DPA
- 🎨 [Brand kit](brand/README.md) — Logo, palette, tokens
- 📊 [Data governance](data-governance/README.md) — Telemetry schema, redaction
- 📘 [Runbooks](runbooks/README.md) — Incident response
- 🤝 [Contributing](CONTRIBUTING.md)
- 🛡️ [Security](SECURITY.md)
- 📊 [Compatibility matrix](compatibility.md)

## 🛠️ Local setup

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

## 🤝 Contributing

See [`CONTRIBUTING.md`](CONTRIBUTING.md). Conventional Commits enforced via `commitlint`.

## 🛡️ Security

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

## 📜 License

[Apache License 2.0](LICENSE).