No description, website, or topics provided.
Ruby HTML JavaScript CSS
Pull request Compare This branch is 10 commits ahead, 1 commit behind NicoleCarpenter:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
lib
log
public
vendor/assets
.gitignore
Gemfile
Gemfile.lock
Procfile
README.md
Rakefile
config.ru
hitters.yaml

README.md

#Chord Explorer

Bring music to the world, one chord at a time.

Chord Explorer is an innovative tool that helps individuals learn how to play guitar and intuitively expand their repertoire. The app allows users to increase their current music knowledge by introducing them to songs that match their current skill level and chord toolbag.

The user is introduced to the website by an option to search using either comma separated values or clickable chord names. Once the user has amassed the chords they want included in the search, the app will generate a list of songs which use those chords. The songs will link to a third party website which will provide the full tab version of the song.

Users are able to save chords in their profile and the app is able to suggest, based on the user's usage, his current repertoire, and frequency of chord appearance within the database, a new chord that may be suited for the user to learn as the next logical chord.

##The Team:

  • Andy Dierker
  • Dennis Tam
  • Erik Germani
  • Nicholas Christiny
  • Nicole Carpenter

##Technologies

  • Ruby on Rails - Open source framework upon which the app is based (version 4.2.4)
  • Ruby - Programming Language primarily used in the app (version 2.2.1)
  • Heroku - Host platform for the app
  • Guitar Party API - API used for song and chord data
  • Anemone - Web crawler framework used for collecting song data from third party sites
  • Bootstrap - HTML, CSS, and JS framework for developing responsive, mobile ready projects on the web
  • Chords.io - jQuery plugin to display guitar chords using Raphaël SVG library.
  • Kaminari - A scope & engine based paginator for Rails 3 and 4

##User Stories

###MVP

####User Registration and Login

  • As a non-logged in user, I want to be able to register for a new account and be redirected to the home page.
  • As a non-logged in user, I want to be able to register for a new account and be redirected to the home page.
  • As a non-logged in user, I want to be able to log in to my account and be redirected to the home page.

####User Profile

  • As a logged in user, when I visit the homepage I will see a "My Profile" link at the top of the main side bar.
  • As a logged in user, I want my profile page to include chords that I have favorited.
  • As a logged in user, I want my profile to include a section with the next recommended chord I should learn

####Developer

  • As a developer, I want to be able to compile a list of songs and the chords they contain. *As a developer, I want to be able to select from compiled songs which version of the song is most reputable.
  • As a developer, I want to present a styled website.

####Main Search Functionality

  • As a user, I should be able to enter multiple chords into a search bar, comma separated and click enter to have them appear in the 'selected chord' area at the top of the page.
  • As a user, I want to be able to click on a chord family (i.e.: major) and have a list of names of clickable chords appear.
  • As a user, I want to be able to click on chords in expanded chord family and have those chord selections appear in the 'selected chord' area on the top of the page.
  • As a user, I want to be able to click a button ("FIND SONGS") and have results appear.

####Display Results

  • As a user, after I search, I want to see a list of songs that utilize the chords that I searched for.
  • As a user, after I search, I want to see what chords I just searched for.
  • As a user, after I search, I should see chord-cards from the returned songs.
  • As a user, I want to limit the number of songs that I see to 10 per page.
  • As a user, I would like the songs that I see in the results to be ordered reasonably by view count.

####Additional Features

  • As a user, I want to be able to view the chord library, a collection of chord cards separated by chord family.
  • As a user, I want the option to save a song to my profile when I know it.