Design Document - gracegong1/US-Citizenship GitHub Wiki
US Citizenship Prep Civics
An app designed to help those who speak a different language pass the US Civics portion of the exam.
Audience
Those who want to practice for the US Citizenship Test. Caters towards those from international backgrounds.
Experience
A user opens the app and can select whether they want to review, take a mock test, or see all 100 questions. They can see their progress with the statistics feature.
Technical
Models
Question
- question: String
- correctAnswers: array of strings
- incorrectAnswers: array of String
- answer: Int
Views
- launchscreen.storyboard
- homescreen.storyboard
- review.storyboard
- test.storyboard
- list.storyboard
- stats.storyboard
Controllers*
- homescreenViewController
- settingsViewController
- reviewIntroViewController
- reviewQuestionViewController
- reviewResultsViewController
- testIntroViewController
- testQuestionViewController
- testResultsViewsController
- listQuestionViewController
- statsMainViewController
- statsPrevTestsViewController
- prevTestQuestionViewController
- statsQuestionBreakdownViewController
Other
a .strings file that contains the language stuff
Weekly Milestone
Week 4 - Usable Build
- Create all storyboards, view controllers, and files.
- Build All UI
- create IB Outlet and Actions
- finish review functionality
- finish practice test
- have usable build by end of the week
Week 5 - Finish Features
- hardcode languages
- implement language
- finish all questions
- finish stats
- finish settings
Week 6 - Polish
- improve UI
- test and debug
- buy apple dev stuffs