broothie / jamdrop

JamDrop is a webapp for Spotify queue sharing

JamDrop

JamDrop is a webapp for queue sharing. Drop songs into your friends' queues! RickRoll them until y'all're nemeses! It's up to you!

Contributing

Overview

Backend

• Go
• Google Cloud Run (serverless Docker image executor) for hosting
• Google Cloud Build for Docker image build / push
• Google Firestore for persistence
• Google Cloud Scheduler for regular jobs
• Cloudflare for DNS

Frontend

• HTML/JS/SCSS
• Mithril for DOM rendering'n'stuf
• Parcel for bundling

Getting Started

A few heads ups

• Currently using cookies as an auth method. That is not the right way to do auth lol.
• Even when running locally, you need to connect to Google Firestore to get to the development collections. It appears there are some solutions for this which should be looked into.
• There's a bunch of long-polling going on from the frontend. Unfortunately, at this point Cloud Run does not provide websocket support, so long-polling is the best option for "live updating" stuffz. I do think, however, there should probably only be one endpoint being polled for updates, instead of the two that currently exist.

A to-do list

• Clone it
• Get a gcloud-key.json and put it at the root of your repo
• Get a .env file and put it at the root of your repo
• Get the backend working
  • Get the right version of Go working (I use gvm)
  • Build it: $ go build cmd/server
  • I like to use the gin hot reloader (along with scripts/dev/gin.sh)
• Get the frontend working
  • $ yarn
  • $ yarn watch

Once you can get two build servers running (gin and parcel) you should be good to hit http://localhost:8080.

Attributions

Icons made by Freepik from www.flaticon.com:

• Jam icon

jamdrop's Issues

add about and explanation page, with links to github?

allow active when not actively on site

improve readme

Browser notifications

start Flutter base

ideas:

• simple three-section UI
• enable tile-sharing such that the Spotify share functionality will be able to use Jamdrop as an option

Remove logging timestamps in prod

Session token ejection job

re-enable phone number adding, but with SMS confirmation

Switch to using localstorage for authentication instead of cookies which is a silly pattern

set up minutely spotify playing job?

improve mobile

allow users to accept/reject queue drops

Online status

Quick share back button

leverage docker-compose for local hosting

Show queued song name

Fix Safari

use web workers for notifications

I think this will allow users to get notifications even if they've closed their tab (and they have stay_active: true)

there are some fire & forget processes that need to not do that

Cloud Run only provides CPU time during a request, so if a request handler spins off a goroutine for async processing, and that goroutine doesn't finish before the handler is finished, it's possible it will not complete. Two examples I can think of off the top of my head:

• session token touch in the sessions middleware
• Twilio song-queued-SMS API call

Async processing is great unless it doesn't work.

Potential solutions:

• use Pub/Sub
• use Cloud Tasks
• switch to using Cloud Functions (I'm not actually sure this will solve it - Functions might have the same problem)

Use a webpacker

add user activity data layer

it would be nice to empower future UX features with some data behind users like:

• number of queue drops from A -> B
• persistence of drop activity in general
  • this would help expand into new features such as:
    • reactions to queue drops, and then the aggregation of those reactions to inform users on whether their queue drops are appreciated

Show user's current song

remove request_id stuff

check for empty write batch

Change follows to embedded doc

add settings page

Add twilio

add tests

add activity feed thingy