Skip to content

Latest commit

 

History

History
47 lines (41 loc) · 2.72 KB

README.md

File metadata and controls

47 lines (41 loc) · 2.72 KB
Raw

README

Codeship Status for BradenLawrence/system-check-radio

System Check Radio

Introduction

System Check Radio is a music app built for teams to nominate songs to a playlist of the week. At the end of each week, the #1 voted song is submitted to a "Greatest Hits" playlist that can be shared and listened to across time. This app is powered by the Spotify API to search for track data and enable song playback.

One of the most challenging parts of this experience has been these intense coding exams that we have every Friday. So I wanted to build something that future students could use to relax and focus while they take those same exams.

Installation

  1. Download the project:
  1. Install gemfiles and yarn packages
  • bundle install
  • yarn install
  1. Add your Spotify credentials
  • This app uses the Spotify api to search for song data. Spotify requires a client ID and client secret to authorize these requests.
  • Sign up for a Spotify account and create a new App.
  • From your app's dashboard, copy your CLIENT ID and CLIENT SECRET and save them in the .env file found in the root directory like so:
    • CLIENT_ID = "enterYourClientIdNumberHere" CLIENT_SECRET = "enterYourClientSecretHere"
  1. Set up your database
  • Inside your .env file, add the email address and password you want to use for your admin account
  • In a terminal use the following commands to set up your database
    • bundle exec rake db:create
    • bundle exec rake db:migrate
    • bundle exec rake db:seed
  1. Start your servers
  • Start the Rails backend using rails s
  • In another terminal window, start the React frontend using yarn start
  1. System Check Radio should now be running on http://localhost:3000
  • You should now see your first playlist, that a logged in user can contribute to
  • You can also sign in to your admin account using the email and password you provided earlier. Using this account, you can navigate to the "/users" page to manage which accounts are allowed to vote and make submissions

Technologies used

  • Ruby 2.6.5
  • Ruby on Rails 5.2.3
  • Spotify api
  • Rspotify
  • Pundit
  • React 16.8.0