Skip to content

Latest commit

 

History

History
116 lines (81 loc) · 6.36 KB

README.md

File metadata and controls

116 lines (81 loc) · 6.36 KB
Raw

WHERE DO I SIGN UP?

I host a demo instance of the app here but please keep in mind I may turn off the server during peak usage to reduce costs. I have set up a Patreon to help offset hosting costs. Please consider donating if you find the app useful.

KoalaCards 🐨

The KoalaCards Logo

Hey there! Welcome to KoalaCards, a fun and friendly spaced repetition system that focuses on listening and speaking skills. KoalaCards captures your voice input using speech-to-text and large language models for human-like test assessments. This has two advantages over traditional spaced repetition systems:

  1. Results are recorded objectively via machine-assisted grading rather than self-grading.
  2. "Close enough" answers that match the meaning of the target sentence and which demonstrate understanding will be accepted. This captures the flexibility of self-grading with the objectivity of external grading.

Table of Contents 📑

Demo Video

Watch a short YouTube demo of the app as of August 2024
KoalaCards UI screenshot

ALPHA Beta Software

The app is now stable enough to be used for serious studying. If you want to use the app but are hitting stability issues, please reach out.

Features 💡

Here's how the app works:

  1. You input target language (KO/ES/FR/IT) sentences with English translations into the app.
  2. The app schedules a queue of sentences using the FSRS scheduling algorithm.
  3. The app asks the user to take a listening or speaking quiz. All quizzes involve listening to target language speech or speaking target language sentences into the microphone. 🎤
  4. The user must pass a quiz to move on to the next card.
  5. The process goes on until the queue is empty.

The app has two types of quizzes:

  • Listening quiz: You listen to a target language phrase and then translate it to English. This quiz comes after the dictation phase. 🎶
  • Speaking quiz: You get an English text and are asked to say it in the target language. The app transcribes your phrase via speech-to-text, and GPT-3 grades your answer. 📣

Other types of quizzes, such as listening comprehension, may be added in the future.

Another Spaced Repetition System?

I studied Korean at university and did self-study for many years before that. I saw lots of flaws in existing solutions but couldn't build alternatives because software tools weren't ready yet. I've been dreaming about building this spaced repetition system for over a decade! Finally, in 2023, it became possible thanks to large language models (LLMs) like GPT and affordable, high-quality text-to-speech and speech-to-text APIs. 🎉

Check out the whitepaper I wrote that explains the main idea. I also wrote a blog article back in 2019 about some problems and solutions with SRS systems.

Developer Setup 🛠️

These instructions may be out of date. Please raise an issue if things don't work!

Prerequisites: NodeJS is required. I've tested it on v20 of node.

The project is in a semi-public alpha phase. If you don't understand the instructions below, you might want to wait for the project to mature before proceeding.

  1. Install NodeJS if you have not done so already.
  2. Clone this repo and cd in.
  3. Create an OpenAI API key.
  4. Create a Google Cloud Service Account JSON credentials file
  5. Make sure the Google Cloud service account can access Cloud Speech API and Cloud Text-to-Speech APIs.
  6. Copy example.env to .env.
  7. Fill out the ENV vars to match your OpenAI / GCS credentials.
  8. Run npm reset.
  9. Run npm start.

Contribution Guidelines 🤝

The source code is permissively licensed and open for review by software developers. Got questions? Raise an issue! You can also reach me via DM on Reddit for general discussion (GitHub and Reddit usernames are the same).

Project Status and Limitations ⚠️

  • I use the app every day, multiple times per day for studying. It is stable, but the documentation is not great. If you want to use this app, consider DMing me on Reddit/LinkedIn for help.
  • By design, the app won't quiz on reading or writing. This is a speaking/listening app and there are better ways to practice writing and reading.
  • The target user is English speakers trying to learn Korean. I have added beta support for ES/FR/IT, but the main focus right now is EN/KO.

Help Needed 📛

The project could use help in the following areas:

  1. I'd like to create a large library of example sentences that are appropriate for use with the app. For this, I'd need the help of a Korean native speaker who can curate and moderate a large corpus of AI-generated phrases containing target grammar/vocab.
  2. UI/UX needs an overall and has not been a priority due to time constraints. If you would like to improve the UI, please reach out.
  3. If you have a background in linguistics or Korean language education, please reach out.
  4. The app relies heavily on Google Cloud and OpenAI for text-to-speech and AI features. I would be interested in exploring other options, such as different TTS or LLM providers.

CORS Setup on Google Cloud

// Run `gsutil cors set cors.json gs://my-bucket`
[
  {
    "origin": [
      "https://app.koala.cards"
    ],
    "method": ["GET", "HEAD", "PUT", "POST"],
    "responseHeader": ["Content-Type"],
    "maxAgeSeconds": 3600
  }
]