Digital web-based flashcard system in Rails, originally written in Django
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
asset_src
bin
config
db
lib
log
public
spec
vendor/assets
.gitignore
.rspec
Gemfile
LICENSE.txt
README.md
Rakefile
STYLE_GUIDE.md
config.ru

README.md

KKSystem

The free and open source cloud flash card system accessed through your web browser. KKSystem uses a modified version of the Leitner system. All card data is stored on a central server which can be operated by someone else or by you. The choice is yours.

KKSystem is written using the Ruby on Rails web framework on the server-side and CoffeeScript on the client-side. Stylesheets are written in Sass.

If you are curious about KKSystem and want to use the official deployal, go to kksystem.org.

Developer Setup

  • Read STYLE_GUIDE.md
  • Install dependencies
    • Run bundle
  • Configure config/user_settings.rb
    • Copy config/user_settings.example.rb to config/user_settings.rb
    • Configure database in config/database.yml from config/database.example.yml
      • Migrate with rake db:migrate
  • Run rails server to run the test server or rails console to drop into the interactive shell