gatoserio/bready repository overview

⁠🍞 Bready

Self-hosted baking companion, installable as a PWA on mobile and desktop.

• Sourdough starters — feeding calculator (keep × ratio × hydration) and a feed log with photos and "last fed" indicators; logging shows a ✅ confirmation (refresh/double-tap safe); a fridge mode (❄️ with temperature) switches reminders to a longer fridge interval; a jar ledger tracks what each feed discards, deducts the levain each bake takes, and accepts "jar now holds X g" corrections; a jar registry (name, photo, empty weight) lets you weigh jar-and-all and have the tare subtracted for you, and a split action seeds a new starter from an existing jar with the grams deducted from its ledger
• Calculators — one baker's-percentage engine powering bread, Italian pizza styles (Napoletana direct / 20% biga / 100% biga / Teglia romana), broa de milho amarelo (with escaldão) and pancakes; flour blends, preferments with correct levain accounting, target-baked-weight scaling with bake-loss estimation, mixer batch planning; extras that come in whole pieces (eggs…) can carry a unit weight so scaled amounts round to whole units ("egg × 2", never 1.7 of one)
• Schedules — every recipe's method steps back-calculated from "I want it ready at…" into clock times, with optional kitchen-temperature adjustment of fermentation durations (Q10)
• Recipes — all of the above as editable templates (duplicate & printable kitchen sheets included), plus your own from scratch
• Journal — "Bake this" freezes formula + schedule into an entry; check off steps in the kitchen (actual vs planned times), rate, note, photograph, calibrate each recipe's real bake loss from measured weights; searchable and filterable
• Live bake mode — full-screen countdown to the next step with tap-to-done and screen wake lock
• Starter analytics — feeds/week, average interval/temp/hydration, discard per week (and its flour cost with the price list) and an interval sparkline from the feed log
• Reminders — push notifications via ntfy⁠: "starter is hungry" on a per-starter interval (nagging repeats — at most daily — until the feed is logged; fridge-mode starters run on their longer fridge interval), and each bake step when its planned time arrives (Settings → Notifications: server + topic, then subscribe in the ntfy app)
• Calendar feed — token-protected /calendar.ics with planned bakes and order due dates for any calendar app
• Export / import — download everything as JSON + photos (recipes also as portable Cooklang⁠ .cook files, downloadable per recipe too); restore the same zip from Settings. Other Cooklang apps read those files as a plain gram recipe at one size (Cooklang has no baker's percentages); an embedded frontmatter line makes re-import into Bready lossless. Foreign .cook files import through a review screen — masses and millilitres convert, cups and unit counts you confirm by hand, and the result is a flat formula without preferment accounting. The import page also offers optional sample recipes (pizza napoletana, sourdough — plain or with chouriço, queijo da ilha, cheese, or coffee, cacau and chocolate chips — focaccia, ciabatta) as one-tap Cooklang loads — nothing is saved unless you keep them (docs/recipes/⁠ has the same files)
• Desktop layout — phones get the compact tab-bar app; at ≥960px the same pages rearrange into a desktop layout: top bar with the app brand, lists as card grids, calculators with the live formula beside the inputs
• Sales (optional) — off by default; enable in Settings for ingredient prices, per-recipe cost & suggested-price estimates (ingredients + energy per oven load + packaging + optional labor at your hourly rate), clients, orders with status flow and costs frozen at order time, partial payments with balances, a 6-month billed/received chart, and a per-day production sheet (aggregated doughs + shopping list with costs)
• Pantry & margin alerts (optional) — track ingredient stock in kg (purchases feed the price list, bakes deduct what they use, the production sheet warns when a day runs short) and get warned when a price change pushes a product below your target margin
• Client portal (optional) — invite clients to a separate /shop login where they browse your published products (bake-day stock or made-to-order with lead times) and place orders that land in your Sales tab for confirmation
• User manual — the full manual ships inside the app at /manual (also linked from Settings → About), so it works offline too

All data is metric grams. UI language is a setting (English and Português available). One SQLite file + a photos folder = the whole state.

⁠Selling & the client portal

Turn on Sales in Settings for costing, clients, orders, payments and a per-day production sheet; add the client portal on top and clients order from a small self-service shop at /shop. Portal orders arrive pending — you confirm or decline, and stock, production, costing and payments stay in sync. Costing counts energy per oven load and (optionally) your hands-on time, freezes each order's costs at creation so past margins stay honest, and — with the optional pantry — tracks ingredient stock and warns before a short production day; margin alerts flag underpriced products when ingredient prices rise:

flowchart LR
    S[Client orders at /shop] --> P(pending)
    M[You type an order in] --> O(open)
    P -- confirm --> O
    P -- decline --> D(declined · stock freed)
    O -- bake day --> B(baked)
    B -- handover --> V(delivered)

See PLAN.md⁠ for the full plan. Status: all seven phases complete. Display options include 24h/12h clock and auto/light/dark theme.

⁠Deploy with Docker

git clone https://github.com/PauloJf/bready && cd bready
# edit docker-compose.yml: set ORIGIN and the Dockflare labels for your hostname
docker compose up --build -d

Notes:

• ORIGIN must match the public URL (e.g. https://bready.example.com) or form submissions fail SvelteKit's CSRF check.
• HTTPS is required for PWA installation. The compose file carries labels for Dockflare⁠-managed Cloudflare tunnels — adjust label names/values to your setup. Any other reverse proxy (Caddy, Traefik, NPM) works too; the app listens on port 3000.
• No ports are published by default; uncomment the ports block for direct LAN testing.
• The container runs as the unprivileged node user (uid 1000), with a read-only root filesystem and all capabilities dropped. The bind-mounted data folder must be writable by uid 1000: mkdir -p data && sudo chown -R 1000:1000 data (existing deployments upgrading from the root-based image need the same chown once).
• On first visit you choose a password (setup screen). Sessions last 90 days. Changing the password signs out all other devices. Set the password before exposing the app publicly — until setup completes, the first visitor picks it.

⁠Backup & restore

Everything lives in the ./data volume: bready.db (SQLite) plus photos/.

• Backup: copy the data/ folder (or use Settings → Export for a portable zip of JSON + photos).
• Restore: stop the container, put your data/ folder back, start it again.

⁠Install as an app

• Android/Chrome: open the site → menu → Add to Home screen / Install app.
• iOS/Safari: share button → Add to Home Screen.
• Desktop Chrome/Edge: install icon in the address bar.

Calculators work offline after first visit; pages you've opened before are cached.

⁠Develop

npm install
npm run dev

• npm test — unit tests (engine, schedule, auth, starter math)
• npm run check — typechecking
• npx drizzle-kit generate --name <name> — new migration after schema changes (migrations run automatically at boot)
• npm run icons — regenerate PWA icons from scripts/icon.html

Stack: SvelteKit (Svelte 5) + SQLite (better-sqlite3/Drizzle), single container, no external services.

⁠License

Bready is free for personal use under the PolyForm Noncommercial License 1.0.0⁠ — use it, change it, share it, as long as the license notice travels with it. One explicit extra permission: running your own small-scale home bakery on it (that's what the Sales module is for) counts as personal use. Offering Bready itself as a product or service is commercial use and needs separate permission. Because of the noncommercial clause this is source-available rather than OSI open source.