Merge pull request #2 from crizmo/dev

v1.1.0 New Features

Author: crizmo

README.md

@@ -20,6 +20,7 @@ KAnki is a spaced repetition flashcard application designed specifically for jai
 - **Error review mode**: Review cards you answered incorrectly right after completing a session
 - **Centralized configuration**: Easy customization through a single configuration file
 - **E-ink optimized UI**: Fixed element heights and visibility management to minimize screen refreshes
+- **Data persistence**: All study progress and card statistics are automatically saved between sessions
 
 ## Technical Limitations
 
@@ -111,6 +112,20 @@ For languages with different writing systems, use the `reading` property:
 {"front": "こんにちは", "reading": "konnichiwa", "back": "Hello", "notes": "Greeting"}
 ```
 
+## Data Storage
+
+KAnki saves your progress and card statistics using the Kindle's localStorage feature. All your data is stored locally on your device at:
+
+```
+/Kindle/.active_content_sandbox/kanki/resource/LocalStorage/file__0.localstorage
+```
+
+If you ever want to reset all progress or encounter issues with saved data, you can:
+
+1. Delete this file to completely reset the application data
+2. Use the "Reset Progress" button within the app to only reset card progress while keeping your deck intact
+3. Use the "Reset All" button to return to the default deck and clear all progress
+
 ## Development
 
 ### Project Structure

kanki/main.js

@@ -143,6 +143,37 @@ function createDefaultDeck() {
   return deck;
 }
 
+// Save deck to localStorage
+function saveDeck() {
+  if (deck) {
+    try {
+      localStorage.setItem('kanki_deck', JSON.stringify(deck));
+      log("Deck saved to localStorage");
+    } catch (e) {
+      log("Error saving deck: " + e.message);
+    }
+  }
+}
+
+// Load deck from localStorage or create a new one if none exists
+function loadDeck() {
+  try {
+    var savedDeck = localStorage.getItem('kanki_deck');
+    if (savedDeck) {
+      deck = JSON.parse(savedDeck);
+      log("Loaded saved deck with " + deck.cards.length + " cards");
+      return true;
+    }
+  } catch (e) {
+    log("Error loading deck: " + e.message);
+  }
+  
+  // If no saved deck or error, create a new one
+  deck = createDefaultDeck();
+  log("Created new default deck");
+  return false;
+}
+
 // Update status message for notifications (not confirmations)
 function updateStatusMessage(message) {
   var statusElement = document.getElementById("statusMessage");
@@ -225,6 +256,8 @@ function calculateNextReview(card, wasCorrect) {
     card.nextReview = now + (10 * 60 * 1000); // 10 minutes
   }
 
+  saveDeck();
+  
   return card;
 }
 
@@ -358,6 +391,8 @@ function displayCurrentCard(showAnswer) {
   if (!showAnswer) { 
     card.timesViewed = (card.timesViewed || 0) + 1;
     card.lastViewed = new Date().getTime();
+    // Save view statistics
+    saveDeck();
   }
 
   updateCardStats(card);
@@ -454,6 +489,9 @@ function answerCard(wasCorrect) {
 
   currentCardIndex++;
 
+
+  saveDeck();
+  
   // Check if we're done with regular cards and have errors to review
   if (!inErrorReviewMode && currentCardIndex % dueCards.length === 0 && incorrectCardsQueue.length > 0) {
     showErrorReviewPrompt();
@@ -480,6 +518,8 @@ function handleAnswerWithInterval(difficulty) {
 
     currentCardIndex++;
 
+    saveDeck();
+    
     // Check if we're done with regular cards and have errors to review
     if (currentCardIndex % dueCards.length === 0 && incorrectCardsQueue.length > 0) {
       showErrorReviewPrompt();
@@ -505,6 +545,8 @@ function answerErrorCardWithInterval(difficulty) {
   // Move to next card
   currentCardIndex++;
 
+  saveDeck();
+  
   if (currentCardIndex >= incorrectCardsQueue.length) {
     endErrorReview();
   } else {
@@ -518,6 +560,9 @@ function changeLevel(level) {
   currentCardIndex = 0; // Reset counter when changing level
   updateLevelDisplay();
   displayCurrentCard(false);
+  
+  // Save user preference for level
+  saveDeck();
 }
 
 // Initialize app on page load
@@ -532,8 +577,10 @@ function onPageLoad() {
 
   updateLevelButtons();
 
-  deck = createDefaultDeck();
-  log("Created new default deck");
+  if (!loadDeck()) {
+    deck = createDefaultDeck();
+    log("Created new default deck");
+  }
 
   updateProgressDisplay();
 
@@ -616,6 +663,7 @@ function resetProgress() {
   inErrorReviewMode = false;
 
   displayCurrentCard(false);
+  saveDeck();
   showToast("Progress has been reset", 2000);
   log("Progress reset");
 }
@@ -632,6 +680,7 @@ function resetAll() {
   isReversedMode = false;
 
   displayCurrentCard(false);
+  saveDeck();
   showToast("All data has been reset", 2000);
   log("Complete reset performed");
 }
@@ -760,6 +809,7 @@ function endErrorReview() {
     currentCardIndex = 0;
     displayCurrentCard(false);
   }
+  saveDeck();
 }
 
 function handleAnswerCard(wasCorrect) {
@@ -769,6 +819,7 @@ function handleAnswerCard(wasCorrect) {
     if (!wasCorrect) {
       answerCard(wasCorrect);
     }
+    saveDeck();
   }
 }
 
@@ -783,6 +834,7 @@ function toggleStarCurrentCard() {
 
   updateStarButton(card.starred);
 
+  saveDeck();
   showToast(card.starred ? "Card starred" : "Card unstarred", 1000);
 }
 
@@ -814,6 +866,9 @@ function toggleStarredFilter() {
 
   updateLevelDisplay();
   displayCurrentCard(false);
+  
+  // Save user preference for starred filter
+  saveDeck();
 }
 
 function toggleCardDirection() {
@@ -832,6 +887,9 @@ function toggleCardDirection() {
 
   displayCurrentCard(false);
 
+  // Save user preference for card direction
+  saveDeck();
+  
   showToast(isReversedMode ? "Reversed Mode: Native → Target" : "Normal Mode: Target → Native", 2000);
 }