Tomas Kracmar
0a4fb7b55e
Includes: - Backend services: ingestion (:8001), weather API (:8002), gateway (:8003), billing (:8004) with BTCPay integration - Shared asyncpg pool, TimescaleDB hypertable, Redis, Mosquitto MQTT - React frontend: Dashboard (MapLibre) and Messaging (chat UI) - Bridge daemon for Pi + Meshtastic (Serial/TCP T-Deck support) - Production Docker Compose, Nginx reverse proxy, ops scripts - DEPLOY.md with step-by-step deployment guide
63 lines
3.5 KiB
Markdown
63 lines
3.5 KiB
Markdown
# KosmoConnect
|
|
|
|
**A Church of Kosmo Technology Project**
|
|
|
|
KosmoConnect is a hybrid environmental monitoring and emergency communication platform built by the Church of Kosmo on the [Meshtastic](https://meshtastic.org/) open mesh protocol. It consists of a network of solar-powered, stationary environmental stations that collect long-term weather data while simultaneously acting as relay nodes for a resilient, off-grid communication network serving the Church of Kosmo community and beyond.
|
|
|
|
## About Church of Kosmo
|
|
|
|
The Church of Kosmo is committed to building resilient, community-owned infrastructure. KosmoConnect is our flagship technology project, combining environmental stewardship with decentralized emergency communications.
|
|
|
|
## Objectives
|
|
|
|
### 1. Enviro-Node Network
|
|
Build and deploy a network of solar-powered environmental monitoring stations ("enviro-nodes") that:
|
|
- Collect weather and environmental data (temperature, humidity, pressure, wind, air quality, etc.)
|
|
- Communicate over Meshtastic mesh radio
|
|
- Relay messages for other mesh clients
|
|
- Offload stored data to central infrastructure via multi-hop routing
|
|
- Operate autonomously year-round on solar power
|
|
- Are available as buildable/salable kits
|
|
|
|
### 2. Web-to-Mesh Gateway
|
|
Create a subscription-based web service that allows users to send messages to any node on the Kosmo mesh from devices without Meshtastic radios (e.g., web browsers, smartphones). Access is limited to paying subscribers and can be restricted per-network or per-node.
|
|
|
|
## Repository Map
|
|
|
|
This is a **monorepo** tracking all components of the project. When individual components mature, they may be extracted into dedicated repositories. Boundaries are clearly marked.
|
|
|
|
| Directory | Purpose |
|
|
|-----------|---------|
|
|
| `docs/` | Architecture, requirements, API specs, deployment guides |
|
|
| `hardware/` | PCB designs, schematics, enclosures, BOMs, solar power calculations |
|
|
| `firmware/` | Enviro-node and infrastructure node firmware |
|
|
| `backend/` | Central server: data ingestion, API, message gateway, BTCPay billing |
|
|
| `web/` | Frontend applications: weather dashboard, messaging client, admin panel |
|
|
| `ops/` | Infrastructure-as-code, deployment automation, monitoring |
|
|
| `tests/` | Integration tests and hardware-in-the-loop validation |
|
|
| `kits/` | Assembly guides, packaging designs, certification docs |
|
|
| `legal/` | Terms of service, privacy policy, open-source licensing |
|
|
|
|
## Quick Links
|
|
|
|
- [System Architecture](./docs/architecture/system-overview.md)
|
|
- [Data Flow](./docs/architecture/data-flow.md)
|
|
- [Messaging Gateway Design](./docs/architecture/messaging-gateway.md)
|
|
- [Product Requirements](./docs/requirements/prd.md)
|
|
- [Hardware Overview](./hardware/README.md)
|
|
- [Dashboard Dev Guide](./web/dashboard/README.md)
|
|
- [Messaging Client Dev Guide](./web/messaging/README.md)
|
|
- [Billing Service](./backend/billing/README.md)
|
|
- [Project Roadmap](./docs/roadmap.md)
|
|
|
|
## License
|
|
|
|
KosmoConnect is a technology project of the Church of Kosmo. The project operates under the spirit of **[The Kosmic License](./legal/LICENSE-KOSMIC.md)** (KΛ 1.0).
|
|
|
|
For legal enforceability, specific components use standard licenses:
|
|
- **Software** (`firmware/`, `backend/`, `web/`, `ops/`, `tests/`): AGPL-3.0
|
|
- **Hardware** (`hardware/`, `kits/`): CERN-OHL-S-2.0
|
|
- **Documentation** (`docs/`): CC-BY-SA-4.0 or The Kosmic License
|
|
|
|
See [legal/README.md](./legal/README.md) for the full licensing guide. We also maintain a proposed improved draft at [KΛ 1.1-Draft](./legal/LICENSE-KOSMIC-DRAFT-1.1.md).
|