The devDependency prettier was updated from 1.14.2 to 1.14.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

prettier is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency @types/enzyme-adapter-react-16 was updated from 1.0.3 to 1.0.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/enzyme-adapter-react-16 is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

There have been updates to the enzyme monorepo:

• • The devDependency enzyme was updated from 3.8.0 to 3.9.0.

• The devDependency enzyme-adapter-react-16 was updated from 1.11.0 to 1.11.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the enzyme group definition.

enzyme is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency @types/enzyme was updated from 3.1.13 to 3.1.14.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/enzyme is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency @types/react-hot-loader was updated from 4.1.0 to 4.1.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/react-hot-loader is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

There have been updates to the enzyme monorepo:

• • The devDependency enzyme was updated from 3.8.0 to 3.9.0.

• The devDependency enzyme-adapter-react-16 was updated from 1.10.0 to 1.11.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the enzyme group definition.

enzyme is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency coveralls was updated from 3.0.2 to 3.0.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

coveralls is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Data model

#srs-project #draft #proposal

Software

PostgreSQL

This will be our main database to handle user data and authentication.

CouchDB

This will be our database to store document based data such as deck, card, and review data. Using a NoSQL database like CouchDB allows us to easily synchronize with clients. Authentication can be shared with our main API, although this might not be completely straightforward. (would require some coding)

RxDB

A reactive offline-first database for Javascript based on PouchDB. Has support for synchronizing with CouchDB-like databases. A great choice for us since our frontend will be mostly reactive/functional.

Client side

These are models that need to be easily synchronized between the server and client.

-- Decks
-- Deck options
-- Cards
-- Card Views
-- Card Types
-- Card Layouts
-- Reviews
-- Settings

Decks

Contains all the data about a collection of cards. A deck can be a sub-deck of another deck as well.

type Deck struct {
	ID BigInt
	ParentID BigInt
	OptionsID BigInt
	Name string
	Description string
}

Deck options

Options for how a deck should behave. Multiple decks can use the same set of options.

type DeckOptions struct {
	ID BigInt
	Name string
	Steps []time.Duration // intervals for learning a card
	NewQuota int // number of new cards that should be shown per day
	InitialMultiplier int // cards need an initial multiplier 
	ReviewQuota int // number of reviews per day for this deck
	LeechQuota int // number of times a card has to fail before it should be marked as a leech 
	LeechAction string // action that should be performed after a card is marked as a leech
	AutoplayAudio bool
}

Cards

Contains the data a user wants to learn. A card can have multiple views, for example:
-- Japanese -> English
-- English -> Japanese
-- Audio (Japanese) -> meaning (English)
-- Phonetic spelling -> kanji

type Card struct {
	ID BigInt
	DeckID BigInt
	TypeID BigInt
	Fields JSON
	Due Timestamp
	ReviewCount int
	Views []CardView
}

Card Views

type CardView struct {
	ID BigInt
	LayoutID BigInt
	Name string
	Due Timestamp // Optional, only when embedded into a Card
}

Card Types

type CardType struct {
	ID BigInt
	Fields []CardField
	DefaultViewIDs []int
}

type CardField struct {
	Name string
	Type string
	Options JSON
}

Card Layouts

type CardLayout struct {
	ID BigInt
	Name string
	Front string
	Back string
	CSS string
}

Reviews

type Review struct {
	ID BigInt
	DeckID BigInt
	CardID BigInt
	ViewID BigInt
	ReviewedAt Timestamp
	Due Timestamp
	ReviewCount int
	Factor float
	Answer int // 0: fail, 1: hard, 2: good, 3: easy
	LastInterval time.Duration // in minutes
	NextInterval time.Duration // in minutes
}

Settings

type Settings struct {
	TimezoneOffset int // offset for the timezone of the user
	RolloverOffset int // offset for when the new day starts 
}

The devDependency @types/jest was updated from 23.3.2 to 23.3.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/jest is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency webpack-cli was updated from 3.1.0 to 3.1.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

webpack-cli is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency @types/webpack was updated from 4.4.11 to 4.4.12.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/webpack is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Why

We'll want more flexibility in what cards can contain.

What

Instead of just using a front/back approach, allow custom fields to be defined.

-> To be fleshed out later

Dependencies

• Review component
• Add templates to cards

There have been updates to the enzyme monorepo:

• • The devDependency enzyme was updated from 3.8.0 to 3.9.0.

• The devDependency enzyme-adapter-react-16 was updated from 1.10.0 to 1.11.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the enzyme group definition.

enzyme is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

There have been updates to the enzyme monorepo:

• • The devDependency enzyme was updated from 3.8.0 to 3.9.0.

• The devDependency enzyme-adapter-react-16 was updated from 1.10.0 to 1.11.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the enzyme group definition.

enzyme is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency webpack-merge was updated from 4.1.4 to 4.1.5.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

webpack-merge is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency react-hot-loader was updated from 4.3.6 to 4.3.7.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

react-hot-loader is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Why

So we don't need to mess around with ugly relative paths.

What

[1:36 AM] blindbox: uh, it's actually pretty simple. webpack's config.resolve.alias is what you want to touch, and do the exact same thing at tsconfig's compilerOptions.paths(edited)

The dependency react-transition-group was updated from 2.4.0 to 2.5.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

react-transition-group is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

The devDependency @types/react-test-renderer was updated from 16.0.2 to 16.0.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/react-test-renderer is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Why

In order to streamline the beginning phase of the project we can use a list of things to work on independently of each other.

Without dependencies

Add support for absolute include paths

Assigned: grab me!

So we don't need to mess around with ugly relative paths.

Router

Assigned: @oohnoitz

• research which router would be good to use
• how navigation/routing in electron works
• decide an implement

Review component

Assigned: @antonve

• card model
• showing cards front/back
• action bar with buttons to flip cards/mark as (in)correct

Decks index component

Assigned: @antonRooseleer

• shows list of decks
• decks should be clickable so we can attach event listeners later

Local datastore

Assigned: @blindbox

We'll need to store our data locally. We'll be using RxDB so we can later sync this with CouchDB on the server.

Mock SRS library

Assigned: grab me!

• should just add a fixed interval to the current date
• work out an interface

SRS algorithm library

Assigned: grab me!

SuperMemo algorithm in Javascript. We'll be optimizing and load balancing this later.

Some interesting places to look at for inspiration:

• ruby implementation: https://github.com/dpwright/srs
• elixir implementation: https://github.com/edubkendo/supermemo
• cpp implementation: https://gist.github.com/ACEfanatic02/987f3c674bc0e93172e7
• SuperMemo2 algorithm: http://www.supermemo.com/english/ol/sm2.htm
• http://www.gwern.net/Spaced-repetition

Adding redux

Assigned: grab me!

Pretty straight forward, we need state management to eventually link all the components together.

With dependencies

Adding new card component

Assigned: grab me!

Component to create a new card.

Dependencies

• Review component
• Deck component
• Local datastore
• Redux

Add multiple field support to cards

Assigned: grab me!

Instead of just using a front/back approach, allow custom fields to be defined.

Dependencies

• Review component
• Card templates

Add templates to cards

Assigned: grab me!

Allow users to write their own templates.
Should happen in coordination with adding multiple fields support.

Dependencies

• Review component
• Multiple field support

There have been updates to the enzyme monorepo:

• • The devDependency enzyme was updated from 3.8.0 to 3.9.0.

• The devDependency enzyme-adapter-react-16 was updated from 1.11.1 to 1.11.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the enzyme group definition.

enzyme is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The dependency styled-components was updated from 3.4.6 to 3.4.7.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

styled-components is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

Why

We need to store our data of cards and decks locally.

What

We'll be using RxDB so we can later sync this with CouchDB on the server.

• add RxDB dependency
• configure the datastore in the project

The devDependency webpack-dev-server was updated from 3.1.8 to 3.1.9.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

webpack-dev-server is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency ts-jest was updated from 23.1.4 to 23.10.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

ts-jest is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Why

We'll want cards to have custom templates.

What

Allow users to write their own templates.
Should happen in coordination with adding multiple fields support.

Dependencies

• Review component
• Add multiple field support to cards

The devDependency jest-enzyme was updated from 6.0.4 to 6.0.5.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

jest-enzyme is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency @types/webpack-merge was updated from 4.1.3 to 4.1.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/webpack-merge is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Why

We need to be able to add cards to review.

What

Component to create a new card.

-> To be fleshed out later

Dependencies

• Review component
• Deck component
• Local datastore

The devDependency babel-loader was updated from 8.0.4 to 8.0.5.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

babel-loader is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency @types/react-dom was updated from 16.0.7 to 16.0.8.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/react-dom is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Why

We need a basic review component to get things started.

What

• card model
• showing cards front/back
• action bar with buttons to flip cards/mark as (in)correct

The devDependency @types/pouchdb-adapter-idb was updated from 6.1.2 to 6.1.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/pouchdb-adapter-idb is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency prop-types was updated from 15.6.2 to 15.7.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

prop-types is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency lint-staged was updated from 7.2.2 to 7.3.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

lint-staged is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

There have been updates to the enzyme monorepo:

• • The devDependency enzyme was updated from 3.8.0 to 3.9.0.

• The devDependency enzyme-adapter-react-16 was updated from 1.10.0 to 1.11.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the enzyme group definition.

enzyme is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency webpack was updated from 4.18.0 to 4.18.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

webpack is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Version 16.4.14 of @types/react was just published.

This version is covered by your current version range and after updating it in your project the build failed.

@types/react is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

WHY

Create a plan to build our MVP.

HOW

Git Convention

• feature/name-of-feature
• bugfix/name-of-bugfix
• hotfix/name-of-hotfix

Coding Style/Standards

• Go: gofmt
• JavaScript: ES6 + airbnb w/ no semicolons

WHAT

Architecture/Structure

• Offline first approach with Electron
• API (Go) will be developed once we have a working offline client

Iteration/MVP

1st: have a basic structure we can build off of

• Architecture/Models
• CRUD Decks
• CRUD Cards
• Review a Deck
  • show all cards with front/back
  • no complex math or anything
  • show front of card by default, hide back of card
  • next button goes to next card
  • show button shows the back of the card

2nd: build the user sandbox and add algo

• SuperMemo implementation
• Offline user

3rd: flesh out review process

• Config per Deck
  • Reviews/day limit
  • New cards/day limit
  • Show new cards in random order/order added

Why

We'll need a router to navigate between different views.

What

• research which router would be good to use
• how navigation/routing in electron works
• decide and implement

Why

We'll need a proper library to space reviews.

What

SuperMemo algorithm in Javascript. We'll be optimizing and load balancing this later.

Resources

Some interesting places to look at for inspiration:

• ruby implementation: https://github.com/dpwright/srs
• elixir implementation: https://github.com/edubkendo/supermemo
• cpp implementation: https://gist.github.com/ACEfanatic02/987f3c674bc0e93172e7
• SuperMemo2 algorithm: http://www.supermemo.com/english/ol/sm2.htm
• http://www.gwern.net/Spaced-repetition

Why

We need an interface to work with so we can quickly iterate.

What

• should just add a fixed interval to the current date
• work out an interface

The devDependency electron-compile was updated from 6.4.3 to 6.4.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

electron-compile is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Why

Simple decks index component to get things started.

What

• deck interface
• shows list of decks
• decks should be clickable so we can attach event listeners later

The devDependency mockdate was updated from 2.0.2 to 2.0.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

mockdate is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The dependency rxjs-compat was updated from 6.3.2 to 6.3.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

rxjs-compat is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

There have been updates to the react monorepo:

• • The dependency react was updated from 16.6.1 to 16.6.2.

• The dependency react-dom was updated from 16.6.1 to 16.6.2.
• The devDependency react-test-renderer was updated from 16.6.1 to 16.6.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the react group definition.

react is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

There have been updates to the enzyme monorepo:

• • The devDependency enzyme was updated from 3.8.0 to 3.9.0.

• The devDependency enzyme-adapter-react-16 was updated from 1.9.1 to 1.10.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the enzyme group definition.

enzyme is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴