Join the team on Slack

Github

Website

Dolphin Flashcard

https://github.com/jacob-macleod/Dolphin-Flashcard-App/tree/main/docs

API Reference

Support

Descriptions of terms used in this documentation. 

Terminology

Introduction

Why Dolphin Flashcards?

How it Works

Quickstart

Contributing

Changelog

Overview

Authentication

Create account

Create or edit a flashcard set for a user. Flashcards contain front, back, review status, and last review date properties.

Create flashcard

Create Folder

Get all the flashcards created by a user.

Get All Cards

Retrieve a flashcard set based on the specified name, folder, and user ID. Returns null if the request body contains an invalid flashcard name and/or folder name

Get Flashcard

Retrieve a flashcard set based on the specified name, folder, and user ID. Returns null if the request body contains an invalid flashcard name and/or folder name.

Get a flashcard item based on the card ID. Flashcard sets store multiple flashcard items, which are the individual flashcards.

Get Flashcard Item

Get all the flashcards to be learned today for a user. If a card's review status is `0.0`, it is not started; if it is `0.x`, it is actively studying; if it is >= `1.x`, it is learned.

Get Today Cards

Move a flashcard set to a new location. Folder locations, such as `currentLocation` or `moveLocation`, are in the format `myfolder1/myfolder2`. If the card is in the root folder, the folder path should be an empty string `""`.

Move Flashcard Set

Create a card goal for the user. Card goals have the following properties: `ID`, `type` (XP), `title`, `end date`, `status` (failed, completed, or in progress), `fail date` (if failed), and `data storing` (cards revised so far, starting XP, desired cards to revise). A card goal is similar to an XP goal but differs in the data section.



Create Card Goal

Create an experience points (XP) goal for the user. XP goals have an `ID`, `type`, `title`, `end date`, `status` (failed, completed, or in progress), `fail date` (if failed), and `data storing` (start date, starting XP, desired XP) properties.

Create XP Goal

Edit Card Goal

Edit an existing experience points (XP) goal for the user.

Edit XP Goal

Update the status of a goal. The possible values for the status of a goal are `completed`, `in progress`, or `failed`. Returns an empty object when the userID provided is invalid.

Term	Description
Flashcard	A card containing user-defined data. Each flashcard has a front and a back side. Like a physical flashcard, you can specify a question or definition on the front and an answer or target term on the back.
Folders	Containers for flashcards and flashcard sets
Goals	Targets you set for yourself. Dolphin Flashcards supports two types of goals: card goals and experience points (XP) goals.
Card goal	The number of flashcards you aim to learn in a predefined period
XP goal	The number of points you aim to accumulate within a given time.
Heatmap	A snapshot of your learning activity. It indicates active study days and the number of cards learned each day.
Streak	Represents the total number of consecutive learning days.

Welcome

Getting Started

Extras

Terminology