Skip to content
 
 

Repository files navigation

Hearth iOS

Hearth logo

A multilingual communication tool that leaves no one behind.
Fully on-device, privacy-first, two-way voice translation for shelter staff and residents.

Native Swift/SwiftUI rewrite of the award-winning youCode 2026 hackathon prototype (🏆 1st Place CWI Experienced Stream · 🥇 Diversity in CS Project Hub Winner).

Status

UI-first development. Target: installable internal build by August 31, 2026. Final languages, translation-quality validation, and the public release date are still to be decided.

Start here

Doc Purpose
docs/PRD.md What v1 is — and explicitly is not
docs/adr/ADRs.md The 8 architecture decisions (guardrails for humans and AI agents)
docs/ROADMAP.md Current dependency order, team structure, schedule, and risks
docs/backlog/model-enrichment.md Post-language-selection model evaluation and enrichment order
docs/design/UI-SPEC.md Canonical design tokens and per-screen behavior
docs/design/august-ui/ Approved August screens and task-mapped flows
docs/specs/ Canonical feature behavior and implementation contracts
docs/sprints/ Sprint-by-sprint task lists with acceptance criteria
AGENTS.md Rules for ALL AI coding agents (Codex, Claude Code, Cursor) — single source of truth

Working with AI agents

Codex reads AGENTS.md automatically; Claude Code reads CLAUDE.md, which points to it — so both tools follow the same rules. Every implementation task should start from a sprint file. Standard prompt (works for either tool):

Read AGENTS.md, docs/PRD.md, docs/adr/ADRs.md, and docs/sprints/sprint-N.md. For UI tasks also read docs/design/UI-SPEC.md and the task-mapped images in docs/design/august-ui/. Implement task N.M. Do not add dependencies or change the engine protocols.

Cloud agents (Codex web) usually can't run Xcode — they write code + tests and a human builds and device-tests before merge (see "Notes for sandboxed/cloud agents" in AGENTS.md).

The hackathon prototype is historical provenance, not a second specification. Hearth does not mirror it. Upstream changes affect this app only after the team intentionally updates the PRD, an ADR, or a canonical file under docs/. The original repository snapshot remains available in Git history at bootstrap commit 7436a2d.

Team

Jasmine Zou · Jianding Bai · Yuko Murayama · Stephanie Xue

Decisions already made (do not re-litigate in PRs)

  • 100% on-device, zero network, zero backend — the FastAPI server is deleted, not ported
  • STT: WhisperKit (small) · MT: one Tiny Aya GGUF via llama.cpp (fallback: Apple Translation) · TTS: AVSpeechSynthesizer
  • SwiftUI + MVVM · iOS 17+ · devices with ≥6 GB RAM (iPhone 12 Pro / iPhone 14 and newer)
  • Final language support and model accuracy are post-August validation decisions, not UI or engine-integration blockers
  • Cut from v1: transcript history, support prompts, region picker, SMS alerts, accounts, analytics

About

Hearth is an AI-integrated multilingual mobile communication and translation tool designed to bridge language barriers in women’s shelters.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages