docs: add PodMan vision README and master plan
Define the product (ambient AI teammate that prevents merge collisions before push), architecture, stack per folder, build order, and demo script. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -1,18 +1,32 @@
|
||||
# Podman
|
||||
# 🛰️ PodMan — Jarvis for engineering teams
|
||||
|
||||
Monorepo for the Podman project.
|
||||
Ambient AI teammate for the **2026 AI Engineer World's Fair Hackathon** (track: **Continual Learning**).
|
||||
|
||||
## Structure
|
||||
Engineers join a **pod** and share their screen + mic. PodMan watches every screen in
|
||||
**realtime**, understands what each person is working on, fuses that with the team's
|
||||
GitHub state, and **proactively prevents collisions before code is even pushed** —
|
||||
speaking up like Jarvis: _"Karti and Yahya are both editing `auth.ts`, Yahya has unpushed
|
||||
changes — here's the diff, want a sync PR?"_
|
||||
|
||||
| Directory | Purpose |
|
||||
| ----------- | ------------------------------------------------ |
|
||||
| `backend/` | Server-side application code and APIs |
|
||||
| `frontend/` | Client-side application / UI |
|
||||
| `database/` | Schema, migrations, and seed data |
|
||||
| `infra/` | Infrastructure, deployment, and IaC |
|
||||
| `shared/` | Code shared across packages (types, utils, etc.)|
|
||||
| `docs/` | Project documentation |
|
||||
> **The moat:** unpushed local code is invisible to the GitHub API. The realtime
|
||||
> screen-vision layer is the *only* way to catch a collision before the push. That is the
|
||||
> whole product — and the reason this is an ambient agent, not a dashboard.
|
||||
|
||||
## Getting started
|
||||
## Monorepo layout
|
||||
|
||||
This is the initial scaffold. Each package will be filled in as development progresses.
|
||||
| Folder | What |
|
||||
|---|---|
|
||||
| `frontend/` | React + Vite PWA — join pod, screen/mic/cam capture, PodMan voice + intervention cards |
|
||||
| `backend/` | PodMan agent: LiveKit room subscriber, Gemini vision, GitHub fusion, collision detector, voice out |
|
||||
| `infra/` | DigitalOcean deploy (App Platform / Droplet), IaC, Dockerfiles |
|
||||
| `database/` | MongoDB Atlas schema + Voyage vector memory for continual learning |
|
||||
| `shared/` | Shared TypeScript types (pod, engineer context, intervention) |
|
||||
| `docs/` | `PLAN.md` (the north star), demo script |
|
||||
|
||||
## Prizes we're stacking
|
||||
|
||||
- 🏆 **Best Gemini 3.5** — $5,000 cash (realtime vision + Live API voice)
|
||||
- 🏆 **Best LiveKit** — Keychron keyboards (realtime transport is the core)
|
||||
- 🏆 **Best DigitalOcean** — credits (deploy target)
|
||||
|
||||
👉 **Read [`docs/PLAN.md`](docs/PLAN.md) first.**
|
||||
|
||||
Reference in New Issue
Block a user