summaryrefslogtreecommitdiff
path: root/makima/ios/README.md
diff options
context:
space:
mode:
authorsoryu-co <bot@soryu.co>2026-04-24 13:15:29 +0000
committersoryu-co <bot@soryu.co>2026-04-24 13:21:12 +0000
commitdb092c79a175e3283f479ee0b234b24bde3c736e (patch)
tree16ae5ba1f2f2f6089ad9f625953fa02d19463ab0 /makima/ios/README.md
parent3679ceb3325033faa2f889ef3dfee5668ef7aeea (diff)
downloadsoryu-makima-ios-scaffold.tar.gz
soryu-makima-ios-scaffold.zip
Add Makima iOS app scaffold (M0 + M1 design system)makima-ios-scaffold
Pure-native SwiftUI client for makima.jp under makima/ios/. M0 (scaffold) - XcodeGen project (iOS 18+, Swift 5.10, bundle co.soryu.makima) - Makefile targets: bootstrap, xcgen, ios-sim-fast, ios-device-fast, test, lint - GitHub Actions workflow ios-ci.yml — builds + runs XCTest on macos-14 - MIT repo root license already in place M1 (design system, web-aesthetic port) - Palette: #0c1729 background, #9bc3ff accent, #3f6fb3 border (ported from Tailwind) - Typography: SF Mono for chrome, uppercase tracked nav labels - Components: DashedBorder, GridOverlay, MastheadBar + WebSocketStatus pill, NavStripPlaceholder (NAV// prefix), JapaneseLongPressText (mobile analogue of JapaneseHoverText), Logo (reuses frontend/public/logo/makima-logo.svg with Canvas concentric-ring fallback), Badge - RootView demo screen: masthead, nav strip, logo, CONTROL SYSTEM badge, SYSTEM// status card, GLOSSARY// card with 命令/契約/聴取/史料 long-press terms Auth (v1 plan, not wired here): x-makima-api-key header — verified against src/server/auth.rs. Authorization: Bearer reserved for v1.1 Supabase OAuth. v1 plan doc: makima/ios/docs/ios-v1-plan.md Not in this PR: networking, WebSocket client, stores, feature surfaces (Home/Contracts/Tasks/Directives/Daemons/Listen), notifications. Those land across M2-M8 per the plan.
Diffstat (limited to 'makima/ios/README.md')
-rw-r--r--makima/ios/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/makima/ios/README.md b/makima/ios/README.md
new file mode 100644
index 0000000..2a6a664
--- /dev/null
+++ b/makima/ios/README.md
@@ -0,0 +1,31 @@
+# Makima iOS
+
+Native iPhone client for [Makima](https://makima.jp) — distributed mesh listening and AI daemon orchestration platform by Soryu LTD.
+
+**Status:** pre-alpha (M0 scaffold). See [`docs/DEVELOPMENT.md`](docs/DEVELOPMENT.md).
+
+**Plan:** see `/root/notes/makima/ios-v1-plan.md` on the infra host, or the mirrored copy in `docs/PLAN.md` once synced.
+
+## Quick start
+
+```bash
+cd makima/ios
+make bootstrap # installs xcodegen if missing
+make ios-sim-fast # builds for iPhone 16 Pro simulator
+```
+
+Xcode 16+, iOS 18+ target, Swift 5.10+, pure SwiftUI. No third-party packages at M0/M1.
+
+## Architecture
+
+Pure native SwiftUI with `@Observable` stores, `URLSession` networking, `URLSessionWebSocketTask` for task livestream, SwiftData for local cache, Keychain for the `x-makima-api-key` credential.
+
+No cross-platform core, no React Native, no Expo. See `../../README.md` for the wider monorepo.
+
+## License
+
+MIT — see repo-root `LICENSE`.
+
+## Privacy
+
+No analytics. No telemetry. The app talks directly to the Makima server URL you configure — by default `https://makima.jp`, but any reachable instance works (`Settings → Server URL`). Credentials are stored in iOS Keychain, scoped per server URL. Full privacy policy: this README.