arsnova.cards

arsnova.cards

Offers spaced-repetition algorithms according to Leitner and SuperMemo-2 and teacher functions to give bonus for repetitive learning.

Name Last Update
.meteor Loading commit data...
client Loading commit data...
docs Loading commit data...
documentation Loading commit data...
i18n Loading commit data...
imports Loading commit data...
private/newsletter Loading commit data...
public Loading commit data...
server Loading commit data...
tests Loading commit data...
.gitignore Loading commit data...
.gitlab-ci.yml Loading commit data...
.gulpfile.js Loading commit data...
.jscsrc Loading commit data...
.jshintrc Loading commit data...
CHANGELOG.md Loading commit data...
CONTRIBUTING.md Loading commit data...
LICENSE Loading commit data...
README.md Loading commit data...
build.gradle Loading commit data...
package.json Loading commit data...
settings.json Loading commit data...
settings_test.json Loading commit data...

arsnova.cards

The Progressive Web App arsnova.cards offers students a modern and intuitive access to one of the most successful and evidence based learning methods, i.e., spaced repetition.

arsnova.cards uses Meteor as application framework. Download and install Meteor to get the app running in your local development environment.

Initial setup

  1. Install Meteor
  2. Clone the remote repository git clone git@git.thm.de:arsnova/flashcards.git
  3. Install the npm package dependencies inside the local repository "flashcards folder" meteor npm install
  4. Set your initial admin user in settings.json

Settings

Change the settings in settings.json according to your needs

Warning: Never publish your production settings file!

Authentication setup (For Google, Facebook and Twitter logins)

  1. Create your Google api keys
  2. Create your Facebook api keys
  3. Create your Twitter api keys

Braintree setup (For PayPal payments)

  1. Create a Braintree sandbox account
  2. Login to the braintree sandbox
  3. Retrieve your api keys (navigate to: My User > View Authorizations)
  4. Insert the keys into settings.json
  5. Inside Braintree sandbox, navigate to Plans from left menu under Reccuring Billing
  6. Create one plan with id "pro" and your preferred price (lowercase for Plan ID, Plan Name's should be "Pro")

Firebase setup (For web notifications)

  1. Create a Firebase project
  2. Get the FCM api key from Firebase project (project settings > cloud messaging > server key)
  3. Insert the key into settings.json (FCM_API_KEY)

Starting the app

To start arsnova.cards on localhost use meteor --settings settings.json inside the repository. You can then access the app from your host machine by opening http://localhost:3000.

Contribution guide

The contribution guide can be found here.

Documentation

The documentation can be found here.

UML Diagrams

CI Pipeline

build status

Credits

arsnova.cards is powered by Technische Hochschule Mittelhessen - University of Applied Sciences.