Tyto API

API to manage courses, events, locations, and attendance tracking.

Routes

All routes return JSON.

• GET /: Root route shows if Web API is running
• GET api/v1/courses: Get list of all courses
• POST api/v1/courses: Create a new course
• GET api/v1/courses/[course_id]: Get a single course
• GET api/v1/courses/[course_id]/events: Get list of events for a course
• POST api/v1/courses/[course_id]/events: Create a new event for a course
• GET api/v1/courses/[course_id]/events/[event_id]: Get a single event
• GET api/v1/courses/[course_id]/locations: Get list of locations for a course
• POST api/v1/courses/[course_id]/locations: Create a new location for a course
• GET api/v1/courses/[course_id]/locations/[location_id]: Get a single location

Install

Install this API by cloning the relevant branch and use bundler to install specified gems from Gemfile.lock:

bundle install

Copy config/secrets-example.yml to config/secrets.yml and adjust as needed.

Setup development database once:

rake db:migrate

Execute

Run this API using:

puma

Test

Setup test database once:

RACK_ENV=test rake db:migrate

Run the test specification:

rake spec

Release check

Before submitting pull requests, please check if specs, style, and dependency audits pass:

rake release_check