Plays Hub

A Rails application for tracking and visualizing your Spotify listening statistics.

runs in Spotify developer mode on https://playshub.sgui.de So if you created an account. Ping plays-hub@sgui.de with the name and email of your spotify account to be added.

Example

Setup Instructions

1. Prerequisites

• Ruby (see .ruby-version or Gemfile for version)
• PostgreSQL
• Node.js & Yarn (for JS/CSS assets)
• Redis (if using caching or background jobs)

2. Clone the Repository

git clone <your-repo-url>
cd plays-hub

3. Install Dependencies

bundle install
yarn install --check-files

4. Environment Variables

Create a .env file (or set these in your environment):

Variable	Description
SPOTIFY_CLIENT_ID	Your Spotify App Client ID
SPOTIFY_CLIENT_SECRET	Your Spotify App Client Secret
SPOTIFY_REDIRECT_URI	Your app's public base URL (no trailing slash), e.g. https://yourdomain.com
PLAYS_HUB_DATABASE_PASSWORD	Password for the main production database
PLAYS_HUB_QUEUE_DATABASE_PASSWORD	Password for the Solid Queue DB (production)
RAILS_ENV	(optional) Rails environment, e.g. development
PORT	(optional) Port to run the Rails server

5. Database Setup

rails db:create db:migrate
rails db:queue_migrate

6. Running the App

rails server

7. Background Jobs

• This app uses Solid Queue for background jobs.
• Jobs are scheduled via config/recurring.yml (e.g., to fetch Spotify activities regularly).
• To run background jobs:

bin/rails solid_queue:start

8. Spotify Integration

• On first login, users must connect their Spotify account.
• Make sure your Spotify app's redirect URI matches SPOTIFY_REDIRECT_URI + /spotify_callback.

9. Running Tests

bundle exec rspec

---

Environment Variables Summary

• SPOTIFY_CLIENT_ID
• SPOTIFY_CLIENT_SECRET
• SPOTIFY_REDIRECT_URI
• PLAYS_HUB_DATABASE_PASSWORD
• PLAYS_HUB_QUEUE_DATABASE_PASSWORD

Set these in your .env or via your deployment provider's secrets manager.

---

Additional Notes

• See config/recurring.yml for scheduled jobs.
• See Gemfile for required gems.
• For any issues, check logs and ensure all ENVs are set correctly.

License

MIT License

Copyright (c) 2025 Guido Schweizer Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.