FlashcardsXBlock

An Open edX platform XBlock to create and display flashcards.

Installation

In a Tutor deployment, you can add it to OPENEDX_EXTRA_PIP_REQUIREMENTS, installing from git:

OPENEDX_EXTRA_PIP_REQUIREMENTS:
- git+https://github.com/open-craft/FlashcardsXBlock.git@main

Or from a Pypi release:

OPENEDX_EXTRA_PIP_REQUIREMENTS:
- FlashcardsXBlock==1.0.1

Usage

Once the Flashcards XBlock is installed in the Open edX environment, you can navigate to the "Advanced settings" of the course in Studio or Authoring, then add "flashcards" to the "Advanced module list".

Then navigate to the unit in the course where you want to add a Flashcards component, and select "Flashcards" from the "Advanced" component list.

Screenshots

Student view:

Editing modal in Authoring:

Development notes

• There is a Github workflow that automatically creates Pypi releases when you create a release on Github.

Frontend

The frontend is built using Typescript and React; it must be built before it can be used. See ./mise.toml and ./frontend/package.json for available tasks. An example development workflow could look something like this:

# install dependencies
mise run frontend-install

# run a development server with hot-reloading
mise run frontend-dev

# edit the frontend files

# when ready, kill the dev server, and build the frontend.
# If you have this XBlock installed on your Open edX devstack, you can then refresh the page to see updates in live components in a course on the devstack.
mise run frontend-build

# check the unit tests
mise run frontend-test

Want to contribute?

If you have a suggestion, question or found a bug, please open an issue.

If you would like to contribute code, please open a pull request with details about the changes that you propose.