Back to KayeBloom

KayeBloom 1.0 · Help

Technical Requirement Document

KayeBloom 1.0 consists of an Android application built with MIT App Inventor and a static companion website. The phone runs the study workflow and stores progress. The website provides documentation, downloads, and links for Google Play testing.

Android platform and screens

TRD-01 Runtime. The direct-download APK uses package appinventor.ai_kelvinvidad23.KayeBloom, version 1.0 and version code 13. Its manifest declares minimum API 19 and target API 36. Confirm installation and file selection on representative Android devices before distribution.

The app includes launch and Home screens, a deck library and detail view, a card editor, review and quiz screens, results, the import preview, Memory Garden, About, and Privacy.

Local storage and privacy

TRD-02 Persistence. Use App Inventor TinyDB to keep the deck library and study state on the device. Persist deck names, card text, starred states, recall levels, completed quiz and streak information, and unfinished-session state. Saved decks and completed progress must survive a restart.

Read the file selected for import. Keep study data in local app storage. Clearing app storage removes the local copy. Android backup and device-transfer settings can affect restoration. Optional AI prompts are copied on demand for use outside the app.

Flashcard import

TRD-03 Parsing. Accept up to 500 cards per import. TXT uses one question-and-answer pair per line, separated by exactly one pipe character (|). CSV uses two fields per card, with quoted fields and doubled quotes inside a field. Accept input from a selected file or pasted text. Validate and preview the parsed cards before committing a named deck.

Quiz scoring and lily growth

TRD-04 Scoring. Calculate the first-round score as the percentage of quiz questions answered correctly in the first round. When that round is completed, raise each correctly answered card’s recall level by one and lower each incorrectly answered card’s level by one. Clamp levels to 0–3. Second Chance must use the missed items and keep its results separate from the first-round score and mastery.

Deck mastery is the sum of recall levels divided by three times the number of cards, expressed as a percentage. An empty deck starts at 0%. The growth bands are Seed at 0%, Sprout at 1–24%, Plant at 25–59%, Lily bud at 60–99%, and Full bloom when every card reaches level 3.

Website and release files

TRD-05 Hosting. Serve HTML, CSS, JavaScript, and bundled media from cPanel over HTTPS. Use relative paths so the site works in its document root or a subfolder. The website requires no server-side application or database.

TRD-06 Help and delivery. Provide direct URLs for the PRD and TRD and open them in a scrollable Help dialog. Support the Close button and Escape, then return focus to the navigation. Serve the signed APK at downloads/KayeBloom.apk. The download page checks the file before enabling the button. Use a signed AAB for the Play Console release workflow.

Verification

Check valid and invalid imports, restart persistence, recall bounds, the five growth bands, and an unchanged first-round score after Second Chance. On the website, verify both Help popups and their full-page links, narrow-screen layout, APK delivery, and the privacy policy URL.