flashback

README

What is Flashback?

Flashback is (will be) a Spaced Repetition Software with a mobile-first, offline-first design. It takes many concepts from existing programs such as Anki.

You can read my blog post about how I believe Anki falls short as an explanation for some of the improvements I eventually hope will exist in Flashback.

Flashback is currently in the very early stages of development, and as such there's not really much to see here.

License

The Flashback client is open source, and released under the MIT license (see LICENSE.txt for details).

The server software is not open source, but the intention is to make access to it free, with the possibility to pay for premium features (such as professionally-created flash card decks) at some future date.

Contributing

Your contributions to this code base are welcome. Feel free to submit a pull request, or create an Issue to request a feature or ask how you specifically can contribute.

Documentation

Index

• Constants
• type AnswerQuality
• type CardView

Constants

const (
	InitialEase float32 = 2.5
	MaxEase     float32 = 2.5
	MinEase     float32 = 1.3
)

Ease factor options

const (
	InitialInterval = fb.Interval(24 * fb.Hour)
	SecondInterval  = fb.Interval(6 * fb.Day)
)

Interval options

const (
	LapseInterval = fb.Interval(10 * fb.Minute)
)

Lapse options

Types

type AnswerQuality

type AnswerQuality int

AnswerQuality represents the SM-2 quality of the answer. See here: https://www.supermemo.com/english/ol/sm2.htm

const (
	// Complete Blackout
	AnswerBlackout AnswerQuality = iota
	// incorrect response; the correct one remembered
	AnswerIncorrectRemembered
	// incorrect response; where the correct one seemed easy to recall
	AnswerIncorrectEasy
	// correct response recalled with serious difficulty
	AnswerCorrectDifficult
	// correct response after a hesitation
	AnswerCorrect
	// perfect response
	AnswerPerfect
)

Answer qualities are borrowed from the SM2 algorithm.

type CardView

type CardView interface {
	DocID() string
	Buttons(face int) (studyview.ButtonMap, error)
	Body(ctx context.Context, face int) (body string, err error)
	Action(ctx context.Context, face *int, startTime time.Time, query interface{}) (done bool, err error)
}

CardView represents a view of a card or card-like object.