Skip to content

jcraigk/phishin

Repository files navigation

Build Status

Phish.in Logo

Phish.in is an open source archive of live Phish audience recordings.

Ruby on Rails and PostgreSQL are used on the backend. There's a web frontend for browsing and playing audio content as well as a public API for accessing content programmatically.

All audio is provided in MP3 format; more formats and sources may be made available at a later time. Files are served directly from the web server and cached via CloudFlare CDN.

Join the Discord to discuss content and development.

Developer Setup

  1. Install Docker

  2. Clone the repo to your local machine

  3. Download the Fixtures Pack and unzip it. This file contains a full database export minus users and API keys. It also includes MP3 audio and PNG waveform attachments for the last Baker's Dozen show, which should be browsable and playable via localhost:3000/2017-08-06 once the local server is running. Additionally it includes MP3s/notes for 2018-12-28 for testing the rails shows:import task.

# Copy SQL dump into PG container and run it
docker cp /path/to/phishin_for_devs.sql phishin_pg_1:/docker-entrypoint-initdb.d/dump.sql
docker exec -u postgres phishin_pg_1 psql phishin postgres -f docker-entrypoint-initdb.d/dump.sql
  1. Create a folder named content in the local project folder. Place the tracks and import folders from the Fixtures Pack inside. Symlink the tracks/audio_files folder as audio in your public folder: ln -s ./content/tracks/audio_files public/audio. If you run Rails outside Docker, set APP_CONTENT_PATH in .env as the absolute path to your content folder.

  2. If you want to run the Postgres database in Docker and develop the app natively (recommended), you can spin it up like this:

make services
bundle
bundle exec rails s

If you are on a Mac ARM and the ruby-audio gem fails to install, try the following:

brew install libsndfile
gem install ruby-audio -- --with-sndfile-dir=/opt/homebrew/opt/libsndfile

Alternatively, if you prefer to develop completely in Docker, build and start the containers like this:

make up
  1. Open your browser and go to http://localhost:3000/2017-08-06. You should be able to view and play the full show.

Testing

To run the specs in Docker:

make spec

To run the specs natively:

make services
bundle exec rails db:setup RAILS_ENV=test
bundle exec rspec

Importing Content

The content import process uses the Phish.net API for setlists. You must first obtain an API key from them and assign it to the environment variable PNET_API_KEY in .env.

If running the Rails app natively, you may need to install ffmpeg.

To import a new show or replace an existing one, name the MP3s according to the import format (I 01 Harry Hood.mp3) and place them in a folder named by date (2018-08-12). Place this folder in ./content/import and run the following command (make bash first if you use Docker):

bundle exec rails shows:import

Use the interactive CLI to finish the import process then go to http://localhost:3000/<date> to verify the import.

Maintenance

You can create a new user via the Rails console (bundle exec rails c). See Devise documentation for details on the authentication system.

Contributions

Forked from StreamPhish by Jeff Lang.

Layout and graphic design by Mark Craig.

Logo design by Justin Craig-Kuhn.