No description, website, or topics provided.
Branch: development
Clone or download
Pull request Compare This branch is 9 commits behind FridaSjoholm:development.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
config
db
lib
log
public
test
tmp
vendor/assets
.gitignore
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
config.ru
dump.rdb

README.md

Lyrically Challenged

####Search for songs by lyrics.

Lyrically Challenged Mockup

Description

LyricallyChallenged is a lyric-based Rails app and iOS app to search for songs. Each song can be played via a Spotify widget and is presented with full lyrics and details on why that song was chosen.

Recent research indicates that lyric-based recommendation systems are 12.6 times more effective than random recommendations, and may offer better recommendations than collaborative filtering, especially, "within small musical niches".

##Usage

  • Visit the LyricallyChallenged main page and search for songs by keyword(s)

  • Each song is displayed with a Spotify widget and full lyrics


The site is available live on Heroku


#To clone the repo for localhost:

0. Clone the repo

In your terminal, navigate to where you want to place the file:

  git clone https://github.com/FridaSjoholm/lyrically-challenged.git

1. Get (and hide) your API keys

2. Include dotenv gem in your gem file (look at https://github.com/bkeepers/dotenv for instructions)

####You'll need to get API keys from:

.env file

This is what our .env file looks like, with the empty strings replaced with API keys.

SPOTIFY_API_OAUTH_KEY = ""
SPOTIFY_CLIENT_ID = ""
SPOTIFY_CLIENT_SECRET = ""
MUSIC_GRAPH_API_KEY = ""
GOOGLE_APPLICATION_CREDENTIALS = "".json
  • The GOOGLE_APPLICATION_CREDENTIALS will be a path file to a json file in the root of your app.

3. Navigate to the project

  • Navigate to the project
  • Run bundle to install gems
  • Start the rails server
  cd lyricallychallenged
  bundle
  rails s

🎉 🎉 Yay! Your site will be live at http://localhost:3000/

About Lyrically Challenged

See our presentation deck here This project was created in our 19th week at Dev Bootcamp, and was built using Rails, HTML/CSS, and Javascript. We used the Spotify, MusicGraph, api.ai, MetroMix, and Google Natural Language APIs.

Contributors

If you are interested in improving or adding new awesome features to LyricallyChallenged, please feel free to submit an issue or a pull request!