/vocabin-old

Vocabin converts raw text to flashcards with English translations, organised by difficulty and ready to import into flashcard applications like Anki.

Primary LanguageTypeScript

Vocabin converts raw text to flashcards with English translations, organised by difficulty and ready to import into flashcard applications like Anki.

Resources

Word frequency lists generated by the Leipzig Corpora are used to group words by frequency.

The TreeTagger library is used for POS-tagging.

Setting up Locally

After cloning this repo and navigating to the project root, follow the steps below to set up the application on your local machine:

  1. Run npm install in both the root and ./server directories.
  2. Download the word frequency data here (SQL format) and upload to your own MySQL server.
  3. Obtain a google translate API key.
  4. Install the TreeTagger library, along with the parameter files for the supported languages (See TreeTagger docs).
  5. Create a file config/dev.json of the following format:
{
  "googleTranslateApiKey": "<Your API key>",
  "cmdPath": "<Your Treetagger CMD directory path>",
  "mysqlCredentials": {
    "database": "<Database name>",
    "username": "<Username>",
    "password": "<Password>",
    "host": "<Host>"
  }
}

Running Locally

  1. In the root directory run npm run start
  2. In ./server run node server.js