Skip to content

fwttnnn/sptfw

Repository files navigation

sptfw
-----

How mediocre is your taste in music? spotify wrapped (unofficial)

Demo
----

    - Video (params@normal) <https://github.com/user-attachments/assets/ce8bf347-5b34-450e-91d1-20bdfd67be65>
    - Video (params@depth:5) <https://drive.google.com/file/d/1Nz8OMbOTjByBwt0xHEDrO-f94i4h4hY6/view>

Prerequisite
------------

You need to have two accounts setup for:

    - Spotify Web API <https://developer.spotify.com>
    - Upstash <https://upstash.com/>

Read the docs, and get Spotify's API client id along with the
client secret. Next, you need to sign up for a free tier Redis
server provided by Upstash, and put the secrets on to the
environment variables (.env) file.

Database
--------

This app uses supabase to collect telemetry data for academic
research purposes, it is optional and will be removed later (in
about ~2 months after the app is officially launched to public).

You can remove the following .env variables to opt out telemetry:

    - SPTFW_SUPABASE_URL
    - SPTFW_SUPABASE_KEY

Quick Start
-----------

Install the dependencies using your favorite package manager:

    yarn install

Start the app, and head to http://127.0.0.1:3000/:

    yarn dev

Parameters
----------

There's some hidden features you can tweak:

    - Time Range: controls how recent the data is, which you can
      toy with via params: (http://127.0.0.1:3000/?range=medium)
      where range can be either "short" | "medium" | "long",
      defaults to "short".

    - Depth: controls how many song(s) is retrieved, which you
      can toy with via params: (http://127.0.0.1:3000/?depth=5)
      where depth is a positive number (>= 1), defaults to 1.

About

(mini) spotify wrapped

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published