https://github.com/courseware/api.coursewa.re

Coursewa.re API
https://github.com/courseware/api.coursewa.re

Last synced: 1 day ago
JSON representation

Coursewa.re API

• Host: GitHub
• URL: https://github.com/courseware/api.coursewa.re
• Owner: Courseware
• License: mit
• Created: 2013-11-10T17:15:35.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-11-10T19:26:36.000Z (about 11 years ago)
• Last Synced: 2024-11-24T09:08:42.892Z (2 months ago)
• Language: Ruby
• Homepage: http://open.coursewa.re
• Size: 277 KB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
The Courseware Project API / api.coursewa.re

============================================

This is a Rails app to provide an oAuth v2 enabled API endpoint for an

existing Coursewa.re instance.

The API responds just JSON.

[![Build Status](https://travis-ci.org/Courseware/api.coursewa.re.png?branch=master)](https://travis-ci.org/Courseware/api.coursewa.re)

# Installation

1. Close the repository

2. Run `bundle install`

3. Run migrations `bundle exec rake db:create db:migrate db:test:prepare`

4. Run `rails s`

Please run `bundle exec rake routes` in order to see the available endpoints.

# Testing

Run `bundle exec rake` to run tests.

# Database

A note on migrations. Ideally, the non API application should handle these!

{include:file:doc/api_documentation.md}