How sota-mitsumori/pennykeep works
Project type and purpose
• This is primarily an iOS personal-finance tracking app (“PennyKeep”) built in Swift/SwiftUI, plus a small static “PennyKeepWebsite” for marketing.
• Purpose: let end users record incomes and expenses, categorize them, even scan receipts, all on‐device.
File structure
• Top‐level Xcode project (PennyKeep.xcodeproj) and Swift source files under PennyKeep/.
• PennyKeep/Transactions/: holds models (Transaction.swift), a persistence/store component (TransactionStore.swift), the receipt‐scanning logic (ReceiptParsing.swift, ReceiptScannerView.swift), plus views and view‐models for categories and transaction lists.
• Root SwiftUI entry points: PennyKeepApp.swift, ContentView.swift, plus feature views: HomeView.swift, SettingsView.swift, CategoryView.swift.
• A separate directory PennyKeepWebsite/ with HTML/CSS for a static marketing site.
• A CI script (ci_scripts/ci_pre_xcodebuild.sh) hinting at a build pipeline.
README for additional insights
• Confirms an iOS app with a polished UI for tracking income/expenses.
• No explicit backend or cloud services—data is managed locally on the device.
a. Main components to represent:
• Mobile App (client)
• SwiftUI Views (ContentView, HomeView, Transaction Views, SettingsView)
• ViewModels / Controllers (CategoryManager, TransactionStore)
• Data Models (Transaction)
• Persistence Layer (e.g., UserDefaults/CoreData wrapper in TransactionStore)
• Device APIs (Camera + VisionKit for receipt scanning)
• Static Website (marketing)
• HTML/CSS assets served over CDN or static host
• CI Pipeline (pre-build script, code signing, test runner)
b. Relationships and interactions:
• UI → ViewModel → Model → Persistence
• ReceiptScannerView → iOS Camera API → ReceiptParsing → TransactionStore
• App Store distribution to end users
• CI pipelines triggered on Git commits, leading to Xcode build and App Store upload
• Static site served separately (no direct coupling to mobile app at runtime)
c. Architectural patterns and design principles:
• MVVM (Views bound to state in TransactionStore/CategoryManager)
• Single‐source‐of‐truth for transaction data
• Modular feature grouping (Transactions folder encapsulates feature)
• Unidirectional data flow (SwiftUI/Combine style)
d. Key technologies and frameworks:
• SwiftUI, Combine (state binding)
• Xcode project structure, Info.plist configuration
• Apple VisionKit or Vision framework for OCR/receipt parsing
• Static site: plain HTML/CSS
• CI shell script for pre-build checks
Detailed capture of architecture
• Don’t simply list files—group them into conceptual layers: Presentation, Business Logic, Data, Device Integration, CI/CD, Marketing.
• How each SwiftUI View ties back to its ViewModel and Model.
• Receipt-scanning path as a sub-flow.
• Version control and build pipeline as a supporting infrastructure layer.