Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/glutanimate/review-heatmap

Anki add-on to help you keep track of your review activity
https://github.com/glutanimate/review-heatmap

anki anki-addon

Last synced: 5 days ago
JSON representation

Anki add-on to help you keep track of your review activity

Awesome Lists containing this project

README

        

Review Heatmap for Anki










> Your learning performance at a glance

Adds a **heatmap graph** to [Anki](https://apps.ankiweb.net/)'s main window which visualizes past and future card review activity, similar to the contribution view on GitHub. Information on the **current streak** is displayed alongside the heatmap. Clicking on an item shows the cards reviewed on that day.

- [Video Demonstration](#video-demonstration)
- [Installation](#installation)
- [AnkiWeb](#ankiweb)
- [Documentation](#documentation)
- [Building](#building)
- [Contributing](#contributing)
- [License and Credits](#license-and-credits)

### Video Demonstration

General Overview | Customization
---------|----------
[![YouTube: Anki add-on: Review Heatmap](https://i.ytimg.com/vi/3Hk5TYdvKnM/mqdefault.jpg)](https://youtu.be/3Hk5TYdvKnM) | [![YouTube: Add-on Update: Review Heatmap](https://i.ytimg.com/vi/2u8p0N47eUg/mqdefault.jpg)](https://youtu.be/2u8p0N47eUg)

(Make sure to enable closed-captions for comments on the demonstrated features)

### Installation

#### AnkiWeb

The easiest way to install Review Heatmap is through [AnkiWeb](https://ankiweb.net/shared/info/1771074083).

#### Manual installation

1. Download the latest `.ankiaddon` file from the [releases tab](https://github.com/glutanimate/review-heatmap/releases) (you might need to click on *Assets* below the description to reveal the download links)
2. Open the folder where your downloads are located and double-click on the downloaded `.ankiaddon` file.
3. Follow the installation prompt and restart Anki if it asks you to

### Documentation

The use of the add-on is documented in the [Wiki section](https://github.com/Glutanimate/review-heatmap/wiki) and a [series of video tutorials on YouTube](https://www.youtube.com/playlist?list=PL3MozITKTz5Y9owI163AJMYqKwhFrTKcT). More information may also be found in the [AnkiWeb description](docs/description.md).

### Building

Review Heatmap's build system recently underwent a number of changes. Updated build instructions will soon be added here. Please stand by.

### Contributing

Contributions are welcome! Please review the [contribution guidelines](./CONTRIBUTING.md) on how to:

- Report issues
- File pull requests
- Support the project as a non-developer

### License and Credits

*Review Heatmap* is *Copyright © 2016-2022 [Aristotelis P.](https://glutanimate.com/) (Glutanimate)*

Inspired by GitHub's contribution calendar and *Forecast graph on Overview page* by Steve AW.

Ships with the following javascript libraries:

- [d3.js](https://d3js.org/) (v3.5.17), (c) Mike Bostock, BSD license
- [cal-heatmap](https://cal-heatmap.com/) (v3.6.2), (c) Wan Qi Chen, MIT license

Review Heatmap is free and open-source software. The add-on code that runs within Anki is released under the GNU AGPLv3 license, extended by a number of additional terms. For more information please see the [LICENSE](https://github.com/glutanimate/review-heatmap/blob/main/LICENSE) file that accompanied this program.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.

----


The continued development of this add-on is made possible
thanks to my Patreon and Ko-Fi supporters.

You guys rock ❤️ !