This page is incomplete.
This is the guide for self-hosting Spoofify. For the Ducky-hosted starter guide, see this page.
Getting Started
1
Prepare your Workspace
Show Steps
Show Steps
1
Clone the Repository
Navigate to the desired location, and clone the GitHub repository to the current directory
git clone https://github.com/duckyyylol/Spoofify .
2
Install NPM Modules
npm install
3
Create a Tunnel
A tunnel is required for local development, as Spotify requires redirect URIs to have the HTTPS protocol.A url using HTTPS will be provided in the terminal after starting the tunnel. <random_words>.trycloudflared.com
- Install Cloudflared
- Run a tunnel pointing to the Vite development port,
5173
cloudflared tunnel --url http://localhost:5173
Cloudflared will throw errors until the app is running. Environment variables must be configured before starting the app.
2
Update Environment Variables
Show Steps
Show Steps
1
Create .env
Copy the
.env.example file to .envcp .env.example .env
2
Update .env
Update the following values within
.envnumber
default:700
required
The width, in pixels, at which to assume mobile viewing for reactivity
number
default:1000
required
The width, in pixels, at which to assume tablet viewing for reactivity
string
default:"local.db"
required
The path of the Sqlite database
string
required
Your Spotify Redirect URIMust exactly match what is entered in the Spotify developer dashboard.
string
required
Your Spotify Client ID
string
required
Your Spotify Client Secret
string
required
Must match the
SPOOFIFY_API_KEY set in the Twitch Bot3
Run the Local Project
npm run dev
4
Build for Production
npm run build