Skip to content

neutron0831/eiken-grade-1

Repository files navigation

icon.pngiken Grade 1

Firebase Hosting

A simple vocabulary book for Eiken Grade 1.

🧠 Word Status and Learning Flow

Each word has three status, depending on the learner's memorization status.

---
title: Word status
---

stateDiagram-v2
    direction LR

    classDef white fill:white,color:black,font-weight:bold,stroke-width:0px
    classDef green fill:#A5D6A7,color:black,font-weight:bold,stroke-width:0px
    classDef red fill:#FFAB91,color:black,font-weight:bold,stroke-width:0px

    Before_learning: Before learning
    Not_remembered: Not remembered
    Learn_&_Review: Learn & Review

    [*] --> Not_remembered:::white
    state Before_learning {
        Not_remembered
    }
    Not_remembered --> Remembered:::green
    Remembered --> Forgot:::red
    state Learn_&_Review {
        Forgot --> Remembered
    }
    Learn_&_Review --> [*]
Loading

Before learning

All words are in the Not remembered status. Once you have memorized the meaning of a word, move its status to Remembered.

Learn & Review

You will review the words you have learned. If you cannot recall the meaning of a word, move its status to Forgot. If you remember the meaning of the word again, move its status back to Remembered.

🚀 Getting Started

Icons by Icons8

✨ Features

Eiken Grade 1 is created to compensate for the shortcomings of ordinary paper vocabulary books. It has four main pages offering various features.

1. Signin Page 2. Top Page 3. Word Page 4. Configuration Drawer
page_signin.png page_top.png page_word.png drawer_configuration.png

1. Signin Page

page_signin.png

Sign in to Eiken Grade 1 with your Google account using Firebase Authentication. Your learning data will be stored in Cloud Firestore, making it possible to synchronize your learning data and configurations across different devices.

Sign in with Google

button_sign_in_with_google.png Press the button to sign in to Eiken Grade 1 with your Google account.

2. Top Page

page_top.png

A scrollable list of words and their meanings

Highlight/Unhighlight a word

The status of an unhighlighted word is Not remembered. Once you have learned a word, you can tap it to make its status Rememembered. The meaning of the word will be automatically hidden (just like covered with a red sheet). If you cannot remember the meaning of a hidden word when reviewing, tap the word to make its status Forgot.

Not remembered Remembered Forgot
word_status_not_remembered.png word_status_remembered.png word_status_forgot.png

Playback audio

English.png Listen to the pronunciation by tapping the English word (unless Toggle audio playback is turned off). If Toggle Japanese audio playback is turned on, Japanese will be played after English. (See Configuration Drawer)

Show word details

Japanese.png See the details of a word by tapping the meaning of it (see Word Page).

Open the configuration drawer

app_bar.png Open the configuration drawer by tapping the icon of your Google account on the right side of the application bar (See Configuration drawer).

3. Word Page

page_word.png

Word details and learning history

Playback audio

English_on_word_page.png Listen to the pronunciation by tapping the English word (unless Toggle audio playback is turned off). If Toggle Japanese audio playback is turned on, Japanese will be played after English. (See Configuration Drawer)

See learning history

The learning history is displayed according to the word status.

Not remembered Remembered Forgot
learning_history_remembered.png learning_history_remembered.png learning_history_forgot.png

4. Configuration Drawer

configurations.png

You can change the configurations and see the progress chart.

Change word level

configuration_word_level.png Choose the level of words to display from A, B, C, and Idioms.

Change word status

configuration_word_status.png Choose the status of the word to be displayed from Not remembered (including Forgot), Remembered, Forgot, and All.

Toggle audio playback

configuration_listen_on_tap.png Toggle whether or not to playback the pronunciation on tapping a word.

Toggle Japanese audio playback

configuration_include_Japanese.png Toggle whether or not to playback Japanese after the pronunciation playback.

Change playback speed

configuration_play_speed.png Change playback speed from 0.5x to 4x.

See progress charts

configuration_progress_charts.png The charts above show the number of Remembered words at each level. The chart below shows the total number of Remembered words since you started learning.

Sign out from Google

configuration_sign_out_from_Google.png Sign out from Eiken Grade 1 to switch your Google accounts for saving your learning data and configurations.

📄 Disclaimer

Warning
Although the code in this repository is MIT licensed, the word and sound assets used in Eiken Grade 1 are third-party copyrighted works and are reproduced for the author's personal use under Article 30 of the Copyright Act. Therefore, distribution of these assets is prohibited.

eiken-grade-1/.gitignore

Lines 12 to 14 in 668d940

assets/mp3/
assets/symbols.json
assets/words.json

About

A simple vocabulary book for Eiken Grade 1.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors