Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 1.92 KB

README.md

File metadata and controls

52 lines (40 loc) · 1.92 KB

Indecks

Indecks is an interactive index card study app built using React/Redux. Use it to study (or cram) test material on a desktop or a mobile device.

Build Status

Features

  • Real-time synchronization of deck data across devices
  • Save data using Twitter, GitHub, Google or email/password for authentication
  • Full GitHub-flavored Markdown support (including images) for card contents
  • Minimalistic layout tailored for desktop and mobile on-the-go viewing
    • Captures swipes on mobile for quickly navigating between cards
  • Keyboard shortcuts for quick navigation (see legend below)
  • Offline persistence with local storage
  • Import/export of decks via JSON

Keyboard Shortcuts

Key Function Context
D Deck Quick Selector Global
/ Keyboard Shortcuts Cheatsheet Global
I Add/Import Deck Global
, Settings Global
RARROW Next Card While viewing a deck
LARROW Previous Card While viewing a deck
A Add a card While viewing a deck
E Edit card While viewing a deck
SPACE Flip card While viewing a deck
S Toggle shuffle While viewing a deck
D Return to deck While viewing a deck

Builds

Local

  1. npm start and open http://localhost:9406 in your browser.
  2. npm test to unit tests

Production

  1. Run npm run build
  2. Copy index.html into /dist
  3. Place /dist on a server

License

MIT