Skip to content

CillianW/Vocabulary-built-on-Interest

Repository files navigation

 Remember Words Tailored to Your image

Doyouremember - Your Personal Vocabulary Assistant

A web application that helps you learn new vocabulary by generating word cards with meanings, examples, audio pronunciations, and images, then automatically adding them to Anki.

Features

  • Generate vocabulary words based on any topic
  • Each word card includes:
    • Definition
    • Example sentence
    • Chinese translation
    • Synonyms
    • Etymology
    • Fun fact
    • Audio pronunciation
    • Related image

Prerequisites

  1. Python 3.11 or higher
  2. Anki with AnkiConnect add-on installed
  3. API keys for:
    • Google Gemini API
    • Rime TTS API
    • Apify

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/Doyouremember.git
cd Doyouremember
  1. Create and activate a virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install dependencies:
pip install -r requirements.txt
  1. Set up environment variables:
cp .env.example .env

Then edit .env and add your API keys.

Anki Setup

  1. Install Anki from https://apps.ankiweb.net/

  2. Install the AnkiConnect add-on:

    • Open Anki
    • Go to Tools > Add-ons > Get Add-ons
    • Enter code: 2055492159
    • Restart Anki
  3. Configure AnkiConnect:

    • Go to Tools > Add-ons > AnkiConnect > Config
    • Replace the configuration with:
{
    "apiKey": null,
    "apiLogPath": null,
    "ignoreOriginList": [],
    "webBindAddress": "127.0.0.1",
    "webBindPort": 8765,
    "webCorsOriginList": [
        "http://localhost",
        "http://127.0.0.1",
        "http://127.0.0.1:8765",
        "http://localhost:8765",
        "https://127.0.0.1",
        "https://localhost",
        "https://127.0.0.1:8765",
        "https://localhost:8765",
        "*"
    ]
}

Usage

  1. Start Anki and keep it running in the background
  2. Start the web server:
python server.py
  1. Open your browser and visit http://localhost:8000
  2. Enter a topic and click "Generate Words"
  3. Click "Add to Anki" to create flashcards

License

This project is licensed under the Non-Commercial Public License (NCPL). This means:

✅ You can:

  • Use this software for personal purposes
  • Modify the software
  • Share the software with others
  • Contribute to the project

❌ You cannot:

  • Use this software for commercial purposes
  • Sell this software or any modifications of it
  • Remove or modify this license notice

All API keys and services used in this project require separate licenses and terms of service agreements.

About

A web application that helps you learn new vocabulary by generating word cards with meanings, examples, audio pronunciations, and images, then automatically adding them to Anki.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors