search

Empirical-org-Archive / Quill-Writer-Archive

Quill Writer - Learning by Writing Together
quill.org
GNU Affero General Public License v3.0
5 stars 4 forks source link

★ Hooking up the site to the Compass API. #11

Open RyanNovas opened 10 years ago

RyanNovas commented 10 years ago

Note: This is our first pass at explaining our brand new and barely documented API. We'll need to work with you to make sure this is clear and to ensure that our API documentation makes sense. Our lead developer can help you with this.

Goal: Integrate Stories with Friends (SWF) with the Compass API (https://github.com/empirical-org/Compass-API) so that lessons/grades will show up in Compass, our learning management system.

How: The Compass database contains lesson names and descriptions. Students and teachers see these without visiting SWF. The SWF database will contain the actual content (i.e. vocab words, definitions, and prompts). These need to be linked together, and then the MatchID and PlayerID variables need to be linked to the specific students and classrooms that they came from in Compass.

wlaurance commented 10 years ago

I'm thinking the node compass client should be it's own module and repo. We could publish it to NPM now or in the future.

quinn commented 10 years ago

agreed, yes. maybe to start we will develop it along-side this project in the same repo? I have an api client generator that I want to use to generate the node / js client, but that may not fit in the timeline necessarily. Here is the ruby template: https://github.com/empirical-org/Compass-Module-Environment/tree/master/templates/clients it is set up to build and publish the lib to rubygems, we can do the same for npm.