Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.99 KB

README.md

File metadata and controls

29 lines (22 loc) · 1.99 KB
Raw

Flashcards Demo App

This repository contains a bare-bones Flashcards app to demonstrate how to integrate an app with the OpenMinds API. The project will evolve over time to showcase more features of the API and to highlight best practices when integrating with OpenMinds.

A demo of the app is available at http://root-1.github.com/flashcards/.

Installing the App

To run the app yourself, you will need to clone the repository and make the directory available through a web server like Apache.

Mac Instructions

  1. Clone the repository into the ~/Sites directory.
  2. Open System Preference and click the "Sharing" icon.
  3. Turn on "Web Sharing".
  4. You can now access the app at http://localhost/~YOUR_USERNAME/flashcards, where YOUR_USERNAME is your Mac user name. Note that you will not be able to connect to OpenMinds until completing the steps in "Registering the App".

Windows Instructions

  1. Install and run a webserver. We'll use Apache for this example.
  2. Your webserver should be able to access a "UserHome" directory. See the github wiki for this repository for detailed instructions on configuring your webserver.
  3. Clone the flashcards repository as a sub-directory in your UserHome directory.
  4. Restart the webserver (Mandatory after making any config changes)
  5. You can now access the app at http://localhost/~YOUR_USERNAME/flashcards, where YOUR_USERNAME is your Windows user name. Note that you will not be able to connect to OpenMinds until completing the steps in "Registering the App".

Registering the App

  1. Visit the Developer Apps page.
  2. Create a new "Flashcards" app. Provide a name and the oAuth callback URL, which should point to oauth_redirect.html on your web server.
  3. Copy the App ID and paste it as the value of APP_ID in flashcards.js.
  4. Replace REDIRECT_URI with your app's oAuth callback URL.
  5. You should now be able to connect to OpenMinds and load data through the OpenMinds API.