Rythmify

🎬 Preview

• Search & Play

• Queue

• Playlist

📚️ Documentation

Get full documentation of internal workings here

🚀 Installation

1. Clone this repository

   git clone https://github.com/swayam25/Rythmify rythmify
   cd rythmify
   

2. Configure the config.json file

   Configuration

   • discord

     • client_id: Discord OAuth2 Client ID
     • client_secret: Discord OAuth2 Client Secret

   • server: Backend server url

   • client: Frontend client url

3. Copy the Client ID and Client Secret from the Discord Developer Portal and paste them into the client_id and client_secret fields, respectively, in the config.json file

4. Add http://localhost:2501/auth/callback to the Discord OAuth2 Redirect URIs

[!NOTE] You can skip the discord developer portal configuration (step 3 & 4) if you don't want to use login related features.

5. For backend

   • Install dependencies

     cd server
     python -m venv .venv
     source .venv/bin/activate
     pip install -r requirements.txt
     

   • Start the server

     fastapi dev --port 2501
     

6. For frontend

   • Install dependencies

     cd client
     npm i
     

   • Start the client

     npm run dev -- --port 2500
     

7. URLs

   • Backend: http://localhost:2501
   • Frontend: http://localhost:2500

🌐 For Production

1. Follow the steps 1-4 from the installation guide. Ignore if already done.

2. For backend

   • Install dependencies (Ignore if already done)
   • Start the server

     fastapi run --port 2501
     

3. For frontend

   • Install dependencies (Ignore if already done)
   • Build the client

     npm run build
     

   • Preview the client

     npm run preview -- --port 2500
     

4. URLs

   • Backend: http://localhost:2501
   • Frontend: http://localhost:2500

[!TIP] Checkout the deployment guide for more information.