Quick Start Guide

🚀 Fastest Way to Get Started

For macOS/Linux:

cd you-music

# One-time setup
./dev-setup.sh

# Start development
./dev.sh

# Visit http://localhost:3000

Stop servers when done:

./dev-stop.sh

See LOCAL_DEV_GUIDE.md for more details.

# Clone the repository
git clone <your-repo-url>
cd you-music

# Start with Docker
docker-compose up -d

# Access the app
open http://localhost:8000

That's it! The app is now running.

Backend:

cd backend
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -r requirements.txt
uvicorn main:app --reload

Frontend (in another terminal):

cd frontend
npm install
npm run dev

Search for Music
- Click "Search" tab
- Enter artist or song name
- Click download button to save
Play Music
- Go to "Library" tab
- Click play button on any song
- Use player controls at bottom
Create Playlist
- Go to "Playlists" tab
- Click "New Playlist"
- Add songs from your library

1. Go to Search tab
2. Search for "Your favorite song"
3. Click download icon
4. Wait for download to complete
5. Find it in Library tab

Copy this URL format:
http://localhost:8000/?music=1

Replace '1' with the music ID
Share with friends!

Copy example env files:

cp backend/.env.example backend/.env
cp frontend/.env.example frontend/.env

Edit as needed for your setup.

"FFmpeg not found"

# Ubuntu/Debian
sudo apt-get install ffmpeg

# macOS
brew install ffmpeg

# Windows
# Download from https://ffmpeg.org/download.html

Port 8000 already in use

# Use different port
docker-compose down
# Edit docker-compose.yml ports section
docker-compose up -d

Database issues

# Reset database
rm data/youmusic.db
docker-compose restart