Spotify playlist lookup

Service that allows lookup of Spotify playlists by songs that they contain.

As featured on Hacker News

Rough plans (in no particular order)

Technical

• Database Migrations - Needed for persistent prod db to update it without a hassle or data loss
• Templates - Together with WTForms, enables easy page creation
• App Factory - Enables setting up a separate app for each test
• Tests - Needs the scaffolding and refactoring for testing to work at all
• Hot Reload - Make the dev app hot-reloadable for way easier front-end development
• Analytics - Add something like Google Analytics, but not that
• Background Tasks - Add Celery and RabbitMQ, get user playlists in the background
• RESTful API - Split out the API for playlist import/search and use it from the front-end #16
• JSON Schema - Add JSON Schema validation #17
• Async - Currently the server can serve only 1 client at a time, so a large playlist import might block other users
• Logs - docker-compose does logging, but the logs are not persisted anywhere
• Proper Error Handling - Any exception shows up to users as an Internal Server Error
• Comprehensive Tests - Tests with reasonable coverage (and testing coverage as a thing we check)
• CI & CD - Automatically test and deploy the main branch if tests pass
• Playlist Updates - Periodically update oldest playlists with their new tracks (as a job of some sort)

App features

• Style - The front-end — literally anything other than plain HTML
• Playlist Import - Importing playlists from the client
• Track Search - Searching playlists by tracks from the client
• Mobile Front-End - The layout is currently not responsive
• Link-Search on mobile - Currently only works on large screens
• Playlist Search by Multiple Tracks - For when there are too many found playlists
• Spotify Login - Allow login with Spotify and automatically import user playlists

Usage

First setup

Requires docker and docker-compose

Fill .env.spotify with your apps details

For running tests, use test_run.sh

For running the development version, see dev_run.sh

For production deployment, use prod_run.sh, but that also requires .env.prod and .env.prod.db to be created and filled

Commonly needed things

The dev backend is at localhost:1337/api/v1, the frontend at localhost:8080

You can connect to the dev database with docker-compose exec db psql --username=spotify_playlist_lookup --dbname=spotify_playlist_lookup_dev

And see server logs with docker-compose logs -f

New migration can be run with docker-compose exec web flask db migrate -m "reason for migration" (containers need to be running)