C
ConvexCompose
Modules
← All modules
G

Garden

In production Personal

A worked example of the module contract, mid-extraction

app.use(garden) Future install shape; not yet published

About

A small, complete plant/garden tracker used as a worked example for the whole contract: a Convex Component, headless useGarden() hooks, a portal.config.ts manifest, and an optional reference UI. It is mid-extraction from a real production deployment. The furthest-along exemplars of the contract today are convex-diary and convex-audio-analyzer; use Garden as a compact study of the shape every module follows.

How it ships

Every ConvexCompose module is the same shape. Take the Component and hooks and bring your own UI, or drop in the optional reference UI.

Layer 1 · MUST
A Convex Component (convex.config.ts + schema + functions), app.use()-installable into your deployment
Layer 2 · MUST
Headless useX() hooks: router-free, style-free, navigation passed in as callbacks
Layer 3 · OPTIONAL
An OPTIONAL React Native + NativeWind reference UI; ignore it and bring your own surface

Highlights

  • Compact worked example of the module contract
  • Real garden runs in a production deployment today
  • Mid-extraction into a defineComponent("garden") Component
  • Authorization from ctx; cross-module links by explicit passed-in userId
  • Ships Component + useGarden() hook + optional reference UI

Proving ground

A real production deployment exercises these domains; one opinionated consumer, not a requirement.

G
A real production deployment
50+ portals on one Convex deployment

Not a published package yet

No ConvexCompose module is an installable npm package today. What exists is the contract, a real production proving ground running 31 authored Components, and packaging in progress led by convex-diary and convex-audio-analyzer.