flashcard

README

flashcard

Description

A Go package for flashcard mainipulation and learning.

⚡️ The project is in rapid stage of development, issues and critics are welcome.

Features

• verbose API
• sqlite as a storage; others can be added via implementing storage.CardRepo and storage.DeckRepo interfaces

Table of contents

• flashcard
  • Description
  • Features
  • Table of contents
  • Getting started
    • Installation
    • Usage

Getting started

See the documentation for further details.

Installation

go get github.com/k1gabyt0/flashcard

Usage

Documentation

Index

• type Card
• type Deck
• type DeckManager
  • func NewManager(storage storage.Storage) DeckManager
  • func NewManagerWithService(service service.FlashcardService) DeckManager

Types

type Card

type Card interface {
	GetDeck() Deck
	GetDomain() domain.Card

	GetWord() string
	ChangeWord(newWord string) error

	GetTranslation() string
	ChangeTranslation(newTranslation string) error

	PutInDeck(deck Deck) error
	Delete() error
}

Card describes flashcard, stored in some deck.

type Deck

type Deck interface {
	GetDomain() domain.Deck

	GetName() string
	Rename(newName string) error

	ListAllCards() ([]Card, error)
	FilterCards(filterFunc func(domain.Card) bool) ([]Card, error)

	FindCards(word, translation string) ([]Card, error)
	FindCardsByWord(word string) ([]Card, error)

	AddCard(word, translation string) (Card, error)

	Clear() error
}

Deck is an interface that describes all opertions that deck of flashcards can do.

type DeckManager

type DeckManager interface {
	ListAllDecks() ([]Deck, error)
	CreateDeck(name string) (Deck, error)
	FindDeckByName(name string) (Deck, error)
	FilterDecks(filterFunc func(domain.Deck) bool) ([]Deck, error)
	DeleteDeckByName(name string) error
}

DeckManager is an interface that describes deck management.

func NewManager

func NewManager(storage storage.Storage) DeckManager

NewManager creates new deckManager with passed storage.

func NewManagerWithService

func NewManagerWithService(service service.FlashcardService) DeckManager

NewManagerWithService creates new deckManager with passed service.