Self-Host Spoofify - Ducky Docs

This is the guide for self-hosting Spoofify. For the Ducky-hosted starter guide, see this page.

Getting Started

Prepare your Workspace

Show Steps

Clone the Repository

Navigate to the desired location, and clone the GitHub repository to the current directory

git clone https://github.com/duckyyylol/Spoofify .

Install NPM Modules

npm install

Create a Tunnel

A tunnel is required for local development, as Spotify requires redirect URIs to have the HTTPS protocol.

Install Cloudflared
Run a tunnel pointing to the Vite development port, 5173

cloudflared tunnel --url http://localhost:5173

A url using HTTPS will be provided in the terminal after starting the tunnel. <random_words>.trycloudflared.com

Cloudflared will throw errors until the app is running. Environment variables must be configured before starting the app.

Update Environment Variables

Show Steps

Create .env

Copy the .env.example file to .env

cp .env.example .env

Update .env

Update the following values within .env

PUBLIC_MOBILE_SIZE

number

default:700

required

The width, in pixels, at which to assume mobile viewing for reactivity

PUBLIC_TABLET_SIZE

number

default:1000

required

The width, in pixels, at which to assume tablet viewing for reactivity

PRIVATE_DATABASE_URL

string

default:"local.db"

required

The path of the Sqlite database

PUBLIC_REDIRECT_URI

string

required

Your Spotify Redirect URIMust exactly match what is entered in the Spotify developer dashboard.

PRIVATE_CLIENT_ID

string

required

Your Spotify Client ID

PRIVATE_CLIENT_SECRET

string

required

Your Spotify Client Secret

PRIVATE_API_KEY

string

required

Must match the SPOOFIFY_API_KEY set in the Twitch Bot

Run the Local Project

npm run dev

Build for Production

npm run build

​Getting Started

Getting Started