Live Demo: https://music-verse-bd6p.vercel.app
MusicVerse is a web app with a Django backend and a React + Vite frontend.
This README gives a short, practical guide to run the project locally, handle large files, and basic CI notes.
Requirements
- Python 3.11+
- Node.js (v18+) and npm
- Git
Quick start — Backend (Windows PowerShell)
- Open PowerShell and change to the project root:
cd "C:\Users\AVYA\Downloads\musicverse-main\musicverse-main"- Create and activate a virtual environment (use Python 3.11):
py -3.11 -m venv .venv
. .venv\Scripts\Activate.ps1- Install Python dependencies:
python -m pip install --upgrade pip
pip install -r requirements.txt- Apply migrations and start the dev server:
python manage.py migrate --noinput
python manage.py runserver 127.0.0.1:8000Open http://127.0.0.1:8000/ in your browser.
Quick start — Frontend
- Open a second terminal and go to the frontend folder:
cd frontend\musicverse-frontend- Install dependencies and start Vite:
npm install
npm run devVite usually serves at http://localhost:5173/.
Environment & configuration
- Use environment variables or a local
.envfile for secrets. Do not commit secrets to the repository. - For CI we use
musicverse/settings_ci.py(checked into repo) so workflows can run without local-only secrets. For production, provide a separate settings file and secure secrets via environment variables.
Large files (audio)
- GitHub rejects files larger than 100 MB. For audio and large binaries use Git LFS. Basic steps:
# Install Git LFS: https://git-lfs.github.com/
git lfs install
git lfs track "*.mp3"
git add .gitattributes
git add path\to\your-large-file.mp3
git commit -m "Track large audio with Git LFS"
git push origin mainCI & tests
- The repository includes a GitHub Actions workflow that runs the Django migrations and tests on push to
main. If you want linting, frontend builds, or caching added, I can extend the workflow.
License
- MIT — see the
LICENSEfile in this repository.