Skip to content

KMen1/Zeenox-Web

Repository files navigation

Zeenox Web

Discord License CodeFactor

Web interface for the Zeenox Discord music bot, for more information about the bot click here

Features

  • Player controls
  • Queue management
  • Spotify integration
  • Real-time updates and data display
  • Synced lyrics
  • Server settings (WIP)

Setup

Requirements

  • Node.js with npm
  • Spotify application, click here to create one
  • Discord application, click here to create one
  • Running instance of the Zeenox bot

⚠️ Note: The bot is required to be running for the web interface to work!
🔎 Required Scopes (discord): identify, email, guilds
🔎 Required Scopes (spotify): user-read-email, playlist-read-private, user-library-modify, user-library-read
⚠️ Note: You will need to add every user to your spotify application in order for them to be able to use spotify related features!


Installation

  1. Clone the repository
git clone https://github.com/KMen1/Zeenox-Web.git
  1. Install dependencies
npm install
  1. Create a .env file in the root directory and add the following variables
BOT_URL= # URL to the Zeenox bot (https://example.com)
NEXT_PUBLIC_WS_URL= # URL to the Zeenox bot websocket (wss://example.com)
DATABASE_URL= # Neon postgres url
DISCORD_CLIENT_ID=
DISCORD_CLIENT_SECRET=
SPOTIFY_CLIENT_ID=
SPOTIFY_CLIENT_SECRET=
  1. Start the server
npm run dev

License