Skip to content

Latest commit

 

History

History
85 lines (51 loc) · 3 KB

README.md

File metadata and controls

85 lines (51 loc) · 3 KB
Raw

Phish.in Logo

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

Ruby on Rails and Grape API wrap a PostgreSQL database on the backend. There's a web frontend written in React for browsing and playing audio content as well as a JSON API for accessing content programmatically.

All audio is provided in MP3 format. More formats and sources may be made available at a later time. Assets including audio MP3s, waveform PNGs, and album art JPEGs 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 Development SQL File and import it:

# Copy SQL dump into PG container and run it
docker cp /path/to/phishin.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. To present production content locally during development, set PRODUCTION_CONTENT=true in your local .env file.

  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
make dev

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

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 set PRODUCTION_CONTENT=false, restart the server, and visit http://localhost:3000/<date> to verify the import.

Contributions

Forked with permission in 2012 from StreamPhish by Jeff Lang.

Software and content maintained by Justin Craig-Kuhn.