weather-bop

Overview
Project story
Getting Started
Tools Utilized
Future Improvements
Contributing

README

Overview

weather-bop is an 11-day, four-person project during Mod 3 of 4, for Turing School's Back End Engineering Program.

Our challenge was to create a web application from idea to inception. Project requirements included: authentication with a third-party service, consuming an API, and solving a real-world problem.

View our deployed version of the weather-bop

Project Story

weather-bop is an application that curates music based upon the synthesis of weather attributes specific to a given location and the audio features of a track. Through algorithms we are able to use Spotify's extensive breakdown of a song (tempo, energy, valence, mode, and speechiness) to directly correlate with elements that comprise weather, namely, temperature, humidity and wind speed. An example of the relationship is that songs with a higher tempo (bpm) will be returned when the search location has current high windspeeds. The songs that are returned with matching weather characteristics come directly from the user's own collection of 'liked songs'. When created, the user is stored in our database with a default location of Denver. However, from the dashboard page they have the ability to both change their default location or simply search any place on the planet that they so choose. When they do either, the dashboard will immediately reload with a new playlist of songs reflecting the weather of the place they searched their. We have also addressed the possibility that a user does not have 'liked' songs in their spotify account. When this happens, the songs that are returned come from a random selection of genres and they also reflect the attributes of the current location be it the default location or a search. Finally, we have imported a Spotify player on the user's dashboard that gives them the ability to listen to the entire playlist or any song within it that they desire.

Getting Started:

To run weather-bop on a local machine, navigate to the directory in which you would like the project to be located, then execute the following commands:

For the weather-bop Rails App:

$ git clone git@github.com:neeruram1/weather-bop.git 
$ cd weatherbop
$ bundle install
$ rails db:create
$ rails db:migrate
$ bundle exec figaro install

For the Sinatra Microservice:

$ git clone git@github.com:sienna-kopf/weather_music2.git
$ cd weatherbop
$ bundle install
$ touch .env

Environment Variable Setup:

Sign Up on the following API:
Spotify
Add the following code snippet to your config/application.yml file in weatherbop.
Make sure to insert the key/secret without the alligator clips ( < > ).

SPOTIFY_CLIENT_ID: <insert>
SPOTIFY_CLIENT_SECRET: <insert>

Sign up for the following API:
OpenWeather
Add the following code snippet to your .env file in weather_music2.
Make sure to insert the key/secret without the alligator clips ( < > ).