LiveTune-be is the backend server for the LiveTune project—an open-source, web-based music streaming app that allows users to enjoy real-time music together using YouTube links. The backend handles room creation, user sessions, and core logic for live interactions.
-
Room Management: Create, update, delete, and list public or private rooms.
-
User Sessions: Lightweight user tracking (no login required; ephemeral session).
-
Real-time Functionality: Enables live updates and interactions within rooms.
- Python 3.x
- Flask
- Flask-SocketIO
- OpenAPI
Make sure you have Python 3.9+ installed.
- Clone the repository
git clone git@github.com:Live-Tune/LiveTune-be.git
cd LiveTune-be- Create and activate a virtual environment
python -m venv venv
source venv/bin/activate # On Windows use: venv\Scripts\activate- Install dependencies
pip install -r requirements.txt- Run the application
python run.py- The OpenAPI specification is available at
openapi.yaml.
We welcome contributions! Please read our CONTRIBUTING.md guide for detailed instructions on how to get involved.
If you're new to the project, check out the issues labeled good first issue to get started.