Merge pull request #274 from elimu-ai/letter-sound-correspondence-lea…

…rning-event Letter sound correspondence learning event
elimu-ai · Oct 26, 2023 · e76c68b · e76c68b
2 parents 02a1fb0 + 75b65b9
commit e76c68b
Show file tree

Hide file tree

Showing 38 changed files with 146 additions and 96 deletions.
diff --git a/README.md b/README.md
@@ -8,9 +8,19 @@ Code library shared amongst the Web application and Android applications.
   <img width="320" alt="Software Architecture" src="https://user-images.githubusercontent.com/15718174/83595568-fb6a1e00-a594-11ea-990a-10c0bd62ed11.png">
 ](https://github.com/elimu-ai/wiki/blob/main/SOFTWARE_ARCHITECTURE.md)
 
+## Development 👩🏽‍💻
+
+```
+mvn clean
+mvn compile
+```
+
+## Release 📦
+
+See [.github/workflows/maven-publish.yml](.github/workflows/maven-publish.yml)
 
 ---
 
-elimu.ai - Free personalized learning for every child on Earth 🌍🌏🌎
+elimu.ai - Open source learning software for out-of-school children ✨🚀
 
-[Website 🌐](https://elimu.ai) | [Wiki 📃](https://github.com/elimu-ai/wiki#readme) | [Projects 👩🏽‍💻](https://github.com/elimu-ai/wiki/projects) | [Milestones 🎯](https://github.com/elimu-ai/wiki/milestones) | [Community 👋🏽](https://github.com/elimu-ai/wiki#open-source-community)
+[Website 🌐](https://elimu.ai) &nbsp; [Wiki 📃](https://github.com/elimu-ai/wiki#readme) &nbsp; [Projects 👩🏽‍💻](https://github.com/orgs/elimu-ai/projects?query=is%3Aopen) &nbsp; [Milestones 🎯](https://github.com/elimu-ai/wiki/milestones) &nbsp; [Community 👋🏽](https://github.com/elimu-ai/wiki#open-source-community)
diff --git a/src/main/java/ai/elimu/model/v2/enums/content/SpellingConsistency.java b/src/main/java/ai/elimu/model/v2/enums/content/SpellingConsistency.java
@@ -1,7 +1,7 @@
 package ai.elimu.model.v2.enums.content;
 
 /**
- * Grapheme-to-phoneme correspondence
+ * Grapheme-to-phoneme (letter-sound) correspondence
  */
 public enum SpellingConsistency {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/BaseEntityGson.java b/src/main/java/ai/elimu/model/v2/gson/BaseEntityGson.java
@@ -1,7 +1,7 @@
 package ai.elimu.model.v2.gson;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public abstract class BaseEntityGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/analytics/AssessmentEventGson.java b/src/main/java/ai/elimu/model/v2/gson/analytics/AssessmentEventGson.java
@@ -5,7 +5,7 @@
 import java.util.Calendar;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public abstract class AssessmentEventGson extends BaseEntityGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/analytics/LearningEventGson.java b/src/main/java/ai/elimu/model/v2/gson/analytics/LearningEventGson.java
@@ -5,7 +5,7 @@
 import java.util.Calendar;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public abstract class LearningEventGson extends BaseEntityGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/analytics/LetterAssessmentEventGson.java b/src/main/java/ai/elimu/model/v2/gson/analytics/LetterAssessmentEventGson.java
@@ -1,7 +1,7 @@
 package ai.elimu.model.v2.gson.analytics;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class LetterAssessmentEventGson extends AssessmentEventGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/analytics/LetterLearningEventGson.java b/src/main/java/ai/elimu/model/v2/gson/analytics/LetterLearningEventGson.java
@@ -1,7 +1,7 @@
 package ai.elimu.model.v2.gson.analytics;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class LetterLearningEventGson extends LearningEventGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/analytics/LetterSoundAssessmentEventGson.java b/src/main/java/ai/elimu/model/v2/gson/analytics/LetterSoundAssessmentEventGson.java
@@ -0,0 +1,57 @@
+package ai.elimu.model.v2.gson.analytics;
+
+/**
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
+ */
+public class LetterSoundAssessmentEventGson extends AssessmentEventGson {
+
+    private Long letterSoundId;
+
+    private String[] letterSoundLetterTexts;
+
+    private String[] letterSoundSoundValuesIpa;
+
+    private Float masteryScore;
+
+    private Long timeSpentMs;
+
+    public Long getLetterSoundId() {
+        return letterSoundId;
+    }
+
+    public void setLetterSoundId(Long letterSoundId) {
+        this.letterSoundId = letterSoundId;
+    }
+
+    public String[] getLetterSoundLetterTexts() {
+        return letterSoundLetterTexts;
+    }
+
+    public void setLetterSoundLetterTexts(String[] letterSoundLetterTexts) {
+        this.letterSoundLetterTexts = letterSoundLetterTexts;
+    }
+
+    public String[] getLetterSoundSoundValuesIpa() {
+        return letterSoundSoundValuesIpa;
+    }
+
+    public void setLetterSoundSoundValuesIpa(String[] letterSoundSoundValuesIpa) {
+        this.letterSoundSoundValuesIpa = letterSoundSoundValuesIpa;
+    }
+
+    public Float getMasteryScore() {
+        return masteryScore;
+    }
+
+    public void setMasteryScore(Float masteryScore) {
+        this.masteryScore = masteryScore;
+    }
+
+    public Long getTimeSpentMs() {
+        return timeSpentMs;
+    }
+
+    public void setTimeSpentMs(Long timeSpentMs) {
+        this.timeSpentMs = timeSpentMs;
+    }
+}
diff --git a/...n/java/ai/elimu/model/v2/gson/analytics/LetterSoundCorrespondenceAssessmentEventGson.java b/...n/java/ai/elimu/model/v2/gson/analytics/LetterSoundCorrespondenceAssessmentEventGson.java
diff --git a/...ain/java/ai/elimu/model/v2/gson/analytics/LetterSoundCorrespondenceLearningEventGson.java b/...ain/java/ai/elimu/model/v2/gson/analytics/LetterSoundCorrespondenceLearningEventGson.java
diff --git a/src/main/java/ai/elimu/model/v2/gson/analytics/LetterSoundLearningEventGson.java b/src/main/java/ai/elimu/model/v2/gson/analytics/LetterSoundLearningEventGson.java
@@ -0,0 +1,37 @@
+package ai.elimu.model.v2.gson.analytics;
+
+/**
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
+ */
+public class LetterSoundLearningEventGson extends LearningEventGson {
+
+    private Long letterSoundId;
+
+    private String[] letterSoundLetterTexts;
+
+    private String[] letterSoundSoundValuesIpa;
+
+    public Long getLetterSoundId() {
+        return letterSoundId;
+    }
+
+    public void setLetterSoundId(Long letterSoundId) {
+        this.letterSoundId = letterSoundId;
+    }
+
+    public String[] getLetterSoundLetterTexts() {
+        return letterSoundLetterTexts;
+    }
+
+    public void setLetterSoundLetterTexts(String[] letterSoundLetterTexts) {
+        this.letterSoundLetterTexts = letterSoundLetterTexts;
+    }
+
+    public String[] getLetterSoundSoundValuesIpa() {
+        return letterSoundSoundValuesIpa;
+    }
+
+    public void setLetterSoundSoundValuesIpa(String[] letterSoundSoundValuesIpa) {
+        this.letterSoundSoundValuesIpa = letterSoundSoundValuesIpa;
+    }
+}
diff --git a/src/main/java/ai/elimu/model/v2/gson/analytics/NumberAssessmentEventGson.java b/src/main/java/ai/elimu/model/v2/gson/analytics/NumberAssessmentEventGson.java
@@ -1,7 +1,7 @@
 package ai.elimu.model.v2.gson.analytics;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class NumberAssessmentEventGson extends AssessmentEventGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/analytics/NumberLearningEventGson.java b/src/main/java/ai/elimu/model/v2/gson/analytics/NumberLearningEventGson.java
@@ -1,7 +1,7 @@
 package ai.elimu.model.v2.gson.analytics;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class NumberLearningEventGson extends LearningEventGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/analytics/StoryBookLearningEventGson.java b/src/main/java/ai/elimu/model/v2/gson/analytics/StoryBookLearningEventGson.java
@@ -1,7 +1,7 @@
 package ai.elimu.model.v2.gson.analytics;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class StoryBookLearningEventGson extends LearningEventGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/analytics/VideoLearningEventGson.java b/src/main/java/ai/elimu/model/v2/gson/analytics/VideoLearningEventGson.java
@@ -1,7 +1,7 @@
 package ai.elimu.model.v2.gson.analytics;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class VideoLearningEventGson extends LearningEventGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/analytics/WordAssessmentEventGson.java b/src/main/java/ai/elimu/model/v2/gson/analytics/WordAssessmentEventGson.java
@@ -1,7 +1,7 @@
 package ai.elimu.model.v2.gson.analytics;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class WordAssessmentEventGson extends AssessmentEventGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/analytics/WordLearningEventGson.java b/src/main/java/ai/elimu/model/v2/gson/analytics/WordLearningEventGson.java
@@ -1,7 +1,7 @@
 package ai.elimu.model.v2.gson.analytics;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class WordLearningEventGson extends LearningEventGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/application/ApplicationGson.java b/src/main/java/ai/elimu/model/v2/gson/application/ApplicationGson.java
@@ -8,7 +8,7 @@
 import java.util.Set;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class ApplicationGson extends BaseEntityGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/application/ApplicationVersionGson.java b/src/main/java/ai/elimu/model/v2/gson/application/ApplicationVersionGson.java
@@ -3,7 +3,7 @@
 import ai.elimu.model.v2.gson.BaseEntityGson;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class ApplicationVersionGson extends BaseEntityGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/content/AudioGson.java b/src/main/java/ai/elimu/model/v2/gson/content/AudioGson.java
@@ -3,7 +3,7 @@
 import ai.elimu.model.v2.enums.content.AudioFormat;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class AudioGson extends ContentGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/content/ContentGson.java b/src/main/java/ai/elimu/model/v2/gson/content/ContentGson.java
@@ -3,7 +3,7 @@
 import ai.elimu.model.v2.gson.BaseEntityGson;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public abstract class ContentGson extends BaseEntityGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/content/EmojiGson.java b/src/main/java/ai/elimu/model/v2/gson/content/EmojiGson.java
@@ -3,7 +3,7 @@
 import java.util.Set;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class EmojiGson extends ContentGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/content/ImageGson.java b/src/main/java/ai/elimu/model/v2/gson/content/ImageGson.java
@@ -4,7 +4,7 @@
 import java.util.Set;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class ImageGson extends ContentGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/content/LetterGson.java b/src/main/java/ai/elimu/model/v2/gson/content/LetterGson.java
@@ -1,7 +1,7 @@
 package ai.elimu.model.v2.gson.content;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class LetterGson extends ContentGson {
 

diff --git a/...ontent/LetterSoundCorrespondenceGson.java → ...odel/v2/gson/content/LetterSoundGson.java b/...ontent/LetterSoundCorrespondenceGson.java → ...odel/v2/gson/content/LetterSoundGson.java
@@ -3,9 +3,9 @@
 import java.util.List;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
-public class LetterSoundCorrespondenceGson extends ContentGson {
+public class LetterSoundGson extends ContentGson {
 
     private List<LetterGson> letters;
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/content/NumberGson.java b/src/main/java/ai/elimu/model/v2/gson/content/NumberGson.java
@@ -1,7 +1,7 @@
 package ai.elimu.model.v2.gson.content;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class NumberGson extends ContentGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/content/SoundGson.java b/src/main/java/ai/elimu/model/v2/gson/content/SoundGson.java
@@ -3,7 +3,7 @@
 import ai.elimu.model.v2.enums.content.sound.SoundType;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class SoundGson extends ContentGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/content/StoryBookChapterGson.java b/src/main/java/ai/elimu/model/v2/gson/content/StoryBookChapterGson.java
@@ -4,7 +4,7 @@
 import java.util.List;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class StoryBookChapterGson extends BaseEntityGson {
 

diff --git a/src/main/java/ai/elimu/model/v2/gson/content/StoryBookGson.java b/src/main/java/ai/elimu/model/v2/gson/content/StoryBookGson.java
@@ -4,7 +4,7 @@
 import java.util.List;
 
 /**
- * For documentation, see https://github.com/elimu-ai/webapp/tree/master/src/main/java/ai/elimu/model
+ * For documentation, see https://github.com/elimu-ai/webapp/tree/main/src/main/java/ai/elimu/model
  */
 public class StoryBookGson extends ContentGson {