README.md

Som Timer Ruby Gem:

Published Som Timer Gem Version 0.0.3 here
Som Timer App here
API python/flask App here

Overview:

Ruby Gem to access the endpoints of the Som Timer API. Source quality wellness content or use this framework for your own timer app! All methods included for this gem return a Ruby Object or a collection or Ruby Objects for ease of use. Detailed documentation for each endpoint can be found in the ./lib/som_timer.rb file here.

Gem Installation :

To install:

$ gem install som-timer

To jump into interactive ruby session and access endpoints:

$ irb
  > require 'som_timer'
# get one timer
  > SomTimer.one_timer
# get a random exercise
  > SomTimer.rand_exercise(<duration>, <category>)
# get all exercises
  > SomTimer.exercises
# update timer
  > SomTimer.update_timer(<work_interval>, <rest_interval>, <sound>)
# get all rests
  > SomTimer.rests
# create rest
  > SomTimer.create_rest(<mood_rating_1>, <mood_rating_2>, <content_selected>, <focus_interval>, <rest_interval>)

Repo Usage:

Clone down and run:

bundle install

Access endpoints based on guide above ^

Som Timer Repos:

• Som Timer BackEnd Repo
  
• Som Timer FrontEnd Repo
  

Author:

Sienna Kopf

Resources Used:

Helpful Tutorial