How kumitaakira453/sutudy_manager_test_for_riverpod works
Project Type and Purpose
• This is a cross-platform Flutter application (iOS & Web) whose goal is to help users manage “subjects” and “study records.”
• It leverages Riverpod for state management, and presents three main screens: a summary of records, a record registration page, and a subject registration page.
File-Structure Snapshot
• Top-level folders:
• ios/ → iOS runner code (Xcode project, asset catalogs, tests)
• lib/ → Dart source:
– datas/ holds initial_data.dart (seed data)
– models/ holds domain models (Record, Subject)
– providers/ holds Riverpod providers (record.dart, subject.dart)
– pages/ holds UI pages (summary.dart, record_register.dart, subject_register.dart)
– main.dart bootstraps the Flutter app
• Configuration: pubspec.yaml, analysis_options.yaml
• CI: .github/workflows/gh-pages.yml (likely publishing web artifacts to GitHub Pages)
Key Architectural Patterns
• Layered architecture:
a. Presentation Layer (Flutter Widgets / Pages)
b. State Management Layer (Riverpod Providers)
c. Domain Layer (Models)
d. Data Layer (initial seed data, future persistence)
• Platform abstraction: Flutter engine targets iOS (Runner.xcodeproj) and Web (index.html).
• CI/CD pipeline: GitHub Actions deploying the web build to GitHub Pages.
Main Components
a. Flutter UI Layer
• SummaryPage, RecordRegisterPage, SubjectRegisterPage
• Widgets, navigation flows
b. Riverpod State Layer
• RecordProvider, SubjectProvider
• Exposes state (List<Record>, List<Subject>) and CRUD methods
c. Domain Models
• Record, Subject classes (attributes)
d. Data Layer / Persistence
• datas/initial_data.dart (seed data)
• Placeholder for future local storage (e.g., SQLite / SharedPreferences / Hive)
e. Platform Targets
• iOS Runner (Xcode project)
• Web (index.html + JS output)
f. CI/CD
• GitHub Action (gh-pages.yml) pushing web artifacts to GitHub Pages
Relationships & Data Flows
• User taps a button in a Page → invokes a method on a Riverpod Provider → Provider updates its in-memory state → UI rebuilds via Riverpod’s state notifications.
• On app start, main.dart loads initial_data.dart into the providers.
• (Optional future path) Provider writes changes to a persistence store; on restart, data is reloaded.
• CI workflow listens for commits on main, builds web bundle, and deploys to gh-pages branch.