Getting Started¶

Follow these steps to set up the Flashcard Quizzer on your local machine.

Prerequisites¶

The project strictly utilizes uv for dependency management and running the application. Make sure you have uv installed.

If you don't have uv installed, check their official installation guide.

Installation¶

Clone the repository:

git clone https://github.com/marcusholmgren/flashcard-quizzer.git
cd flashcard-quizzer

Sync the environment: Use uv to create the virtual environment and install dependencies based on the uv.lock file.
```
uv sync
```

Sample Data Files¶

The application requires flashcards to be stored in JSON format. It supports two different structures.

Format 1: Array of Objects

[
  {
    "front": "What does HTTP stand for?",
    "back": "HyperText Transfer Protocol"
  },
  {
    "front": "What is 1 + 1?",
    "back": "2"
  }
]

Format 2: Wrapped Object

{
  "cards": [
    {
      "front": "What does HTTP stand for?",
      "back": "HyperText Transfer Protocol"
    }
  ]
}

Store your decks in the data/ directory (or anywhere on your machine).

Running Your First Quiz¶

Once you have a JSON file ready, you can start the application:

uv run flashcard-quizzer -f data/greek_mythology.json -m sequential

For more details on commands and flags, see the CLI Reference.