0xWheatyz
40631fee7c
Initial scaffolding committed by bootstrap script. See ROADMAP.md for phase plan and SESSION_LOG.md (api-company only) for context.
51 lines
2.1 KiB
Markdown
51 lines
2.1 KiB
Markdown
# api-company Roadmap
|
|
|
|
Cross-repo milestones. Per-API phases live in each API repo's ROADMAP.md.
|
|
|
|
## Phase 0 — Orientation (one-time)
|
|
- [ ] Audit cluster: nodes, namespaces, ingress, Flux state → `docs/cluster-audit.md`
|
|
- [ ] Add Flux GitRepository + Kustomization watching `leeworks-agents/api-company`
|
|
- [ ] Deploy `gitea-act-runner` in cluster via Flux HelmRelease (`flux/gitea-runner/`)
|
|
- [ ] Stand up `registry.leeworks.dev` (container registry) — required before any API CI works
|
|
|
|
## Phase 1 — API Contracts
|
|
Each API repo writes its `openapi.yaml` first and lints it. Spec is the source of truth.
|
|
- See: `leeworks-agents/zip-enrichment`, `holidays`, `air-quality`
|
|
|
|
## Phase 2 — Data
|
|
Per-API: pull free public data sources, cache locally (SQLite or in-memory), schedule monthly re-seed.
|
|
|
|
## Phase 3 — Servers
|
|
Per-API: implement Fastify/FastAPI service matching `openapi.yaml` exactly. RapidAPI proxy-secret middleware on every route.
|
|
|
|
## Phase 4 — Monitoring
|
|
- [ ] Prometheus + Grafana via Flux HelmRelease (`flux/monitoring/`)
|
|
- [ ] Gatus public status page at `status.leeworks.dev`
|
|
- [ ] Instrument every API with `api_requests_total`, `api_response_duration_seconds`, `api_data_freshness_seconds`
|
|
|
|
## Phase 5 — Documentation site
|
|
- [ ] `docs-site/` Astro + Redoc skeleton
|
|
- [ ] Gitea Actions pipeline that copies per-API `openapi.yaml` files at build time
|
|
- [ ] Deploy to `docs.leeworks.dev` via Flux
|
|
- [ ] One SEO blog post per API minimum (see master prompt §Phase 5)
|
|
|
|
## Phase 6 — Pre-launch
|
|
- [ ] `docs/legal/terms-of-service.md`
|
|
- [ ] `docs/legal/privacy-policy.md`
|
|
- [ ] `docs/legal/acceptable-use-policy.md`
|
|
- [ ] DNS: `zip.leeworks.dev`, `holidays.leeworks.dev`, `aqi.leeworks.dev`, `docs.`, `status.`, `registry.`
|
|
- [ ] PayPal linked to RapidAPI (manual, on 18th birthday)
|
|
- [ ] Paid tiers enabled on RapidAPI listings (manual)
|
|
|
|
## Revenue target
|
|
|
|
$100/mo **net** ≈ $136/mo gross after RapidAPI 25% + PayPal ~2%.
|
|
|
|
| Plan baseline | Subs needed for net $100/mo |
|
|
|---|---|
|
|
| 15 Basic @ $9 | $122 net |
|
|
| 7 Pro @ $19 | $97 net |
|
|
| 3 Ultra @ $49 | $107 net |
|
|
|
|
(Per-API rough math; mix-and-match across the 3 APIs.)
|