This is the base repo for Jam Sessions, designed and built by Turing students.
This is a Ruby on Rails application used to provide a central hub for categorized, timed study sessions. Users can connect their Spotify account to have music access/control while using the application. Users are provided with a new quote for inspiration with every dashboard and study session visit. Users can see their previous study sessions topics and time durations, giving the ability to monitor time spent on topics or to quickly clone a similar session.
Clone down the repo
$ git clone https://github/Maxwell-Baird/Jam_Session
Install the gem packages
$ bundle install
Set up the database
$ rails db:create
$ rails db:migrate
$ rails db:seed
This project makes use of two API's, the Spotify API and the Daily Quote API.
First, acquire a Spotify Client ID and Secret here:
Once you have obtained an API key and enabled the API:
- Run
bundle exec figaro install - This will create the file
config/application.yml. Open that file. - Append the following to that file:
SPOTIFY_CLIENT_ID_1: <your client_id>, and on a new line,SPOTIFY_CLIENT_SECRET_1: <your client_secret>
This app uses Spotify OAuth.
- Sign into your Spotify account on the developer dashboard page to obtain a client_id and client_secret.
- Open your
config/application.ymlfile and addSPOTIFY_CLIENT_ID_1: <YOUR CLIENT ID>andSPOTIFY_SECRET_1: <YOUR_CLIENT_SECRET>
This API was an additional consumption, it is a very simple API and does not require any keys or ID's. https://type.fit/api/quotes
You can run the test suite with:
$ bundle exec rspec
If set up correctly, and assuming you have internet access and both the Spotify and Daily Quote API is functioning correctly, you should have all passing tests.
- Ruby 2.5.3
- Rails 5.2.4.