Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 5.27 KB

README.md

File metadata and controls

43 lines (31 loc) · 5.27 KB

Emoji Flashcards

"Emoji Flashcards" is a tool to help generate Anki flashcards from emoji/text/audio pairings. These emoji flashcards are meant to be used at the beginning of language learning, in order to give some confidence in vocabulary and act as a supplement for more language-specific learning. These are not intended to be a list of "most common words", but rather are a list of pictographic words that are hopefully fairly translatable across many languages and cultures. This is NOT a flashcard studying app by itself.

Note

You can help improve translations! Read our Contribution Guide and join our Discord to learn more!

A Generated Anki Flashcard

Running Emoji Flashcards

The only prerequisite to running Emoji Flashcards is Deno. There are also a few optional requirements, which are needed for specific tasks.

task description
deno task start Runs the Emoji Flashcards website
deno task test Makes sure everything works. Please run this before making a PR
deno task gen:anki Generates Anki Decks from data. Use this to build decks from source
deno task gen:audio es-ES Generates audio files from data. It is NOT recommended to use this task if you are trying to contribute by adding new translations, since I will need to run it again later anyways. Requires a local installation of ffmpeg, and a Azure API key
deno task gen:text Generates translations from source. Requires a DeepL and/or Azure API key

Navigating this Repository

  • data is where all the language-specific stuff is; translations, extensions, plugins, templates (note: for filesize constraints, audio and anki decks are generated here, but not stored).
  • main.ts is the entrypoint for the website. All the other website client and templating is stored in www.
  • tasks contains all the non-website scripts (every deno task xxx command)
  • utilities is all the logic shared between the scripts, website, and plugins.

License and References and Stuff

  • Icon is from Google's Emoji Kitchen: Noto Color Emoji
  • Initial Text-to-Speech is generated by Microsoft Azure AI. Audio may be replaced on a word-to-word basis.
  • Initial translations are from DeepL and Microsoft Azure AI. Translations may be replaced on a word-to-word basis.
  • Emoji Flashcards includes code from genanki and genanki-js; I modified a bit to fit my purposes, but that is all the contained within ./utilities/genanki, and their licenses apply to their code.

Word lists are inspired by...