Delete README.md
Browse files
README.md
DELETED
|
@@ -1,99 +0,0 @@
|
|
| 1 |
-
# VibeSync - AI-Powered Playlist Generator 🎵
|
| 2 |
-
|
| 3 |
-
Create personalized music playlists using AI personality analysis and export them directly to Spotify!
|
| 4 |
-
|
| 5 |
-
## Features
|
| 6 |
-
|
| 7 |
-
✨ **AI-Powered Recommendations** - Uses Groq LLM to analyze your personality quiz and curate perfect songs
|
| 8 |
-
🎧 **Spotify Integration** - Export playlists directly to your Spotify account
|
| 9 |
-
🎨 **Beautiful UI** - Premium gradient design with smooth animations
|
| 10 |
-
💬 **Smart Suggestions** - Ask AI for more songs based on your preferences
|
| 11 |
-
|
| 12 |
-
## Setup Instructions
|
| 13 |
-
|
| 14 |
-
### 1. Install Dependencies
|
| 15 |
-
|
| 16 |
-
```bash
|
| 17 |
-
pip install -r requirements.txt
|
| 18 |
-
```
|
| 19 |
-
|
| 20 |
-
### 2. Get API Keys
|
| 21 |
-
|
| 22 |
-
#### Groq API Key (Required for AI recommendations)
|
| 23 |
-
1. Go to [Groq Console](https://console.groq.com/)
|
| 24 |
-
2. Sign up or log in
|
| 25 |
-
3. Create a new API key
|
| 26 |
-
4. Copy the key
|
| 27 |
-
|
| 28 |
-
#### Spotify API Credentials (Optional - for playlist export)
|
| 29 |
-
1. Go to [Spotify Developer Dashboard](https://developer.spotify.com/dashboard)
|
| 30 |
-
2. Log in with your Spotify account
|
| 31 |
-
3. Click "Create an App"
|
| 32 |
-
4. Fill in app name and description
|
| 33 |
-
5. In app settings, add `http://localhost:8501` to "Redirect URIs"
|
| 34 |
-
6. Copy your **Client ID** and **Client Secret**
|
| 35 |
-
|
| 36 |
-
### 3. Configure Environment Variables
|
| 37 |
-
|
| 38 |
-
Create a `.env` file in the project directory:
|
| 39 |
-
|
| 40 |
-
```bash
|
| 41 |
-
cp .env.example .env
|
| 42 |
-
```
|
| 43 |
-
|
| 44 |
-
Edit `.env` and add your credentials:
|
| 45 |
-
|
| 46 |
-
```
|
| 47 |
-
GROQ_API_KEY=your_groq_api_key_here
|
| 48 |
-
SPOTIFY_CLIENT_ID=your_spotify_client_id_here
|
| 49 |
-
SPOTIFY_CLIENT_SECRET=your_spotify_client_secret_here
|
| 50 |
-
SPOTIFY_REDIRECT_URI=http://localhost:8501
|
| 51 |
-
```
|
| 52 |
-
|
| 53 |
-
### 4. Run the App
|
| 54 |
-
|
| 55 |
-
```bash
|
| 56 |
-
streamlit run app.py
|
| 57 |
-
```
|
| 58 |
-
|
| 59 |
-
The app will open in your browser at `http://localhost:8501`
|
| 60 |
-
|
| 61 |
-
## How to Use
|
| 62 |
-
|
| 63 |
-
1. **Start the Quiz** - Click "Start Your Vibe Journey"
|
| 64 |
-
2. **Connect Spotify** (Optional) - Click "Connect Spotify" to link your account
|
| 65 |
-
3. **Answer Questions** - Complete 8 personality questions about your mood and preferences
|
| 66 |
-
4. **Get Your Playlist** - AI will generate 10-12 personalized song recommendations
|
| 67 |
-
5. **Export to Spotify** - If connected, create the playlist in your Spotify account
|
| 68 |
-
6. **Add More Songs** - Use AI to get additional suggestions
|
| 69 |
-
|
| 70 |
-
## Demo Mode
|
| 71 |
-
|
| 72 |
-
The app works without API keys in demo mode:
|
| 73 |
-
- Without Groq API: Shows a pre-defined playlist
|
| 74 |
-
- Without Spotify: Can't export playlists (view only)
|
| 75 |
-
|
| 76 |
-
For the best experience, configure both APIs!
|
| 77 |
-
|
| 78 |
-
## Troubleshooting
|
| 79 |
-
|
| 80 |
-
**Spotify Authentication Issues:**
|
| 81 |
-
- Make sure the redirect URI in your Spotify app settings matches exactly: `http://localhost:8501`
|
| 82 |
-
- Clear `.spotify_cache` file if you have authentication errors
|
| 83 |
-
- Check that your Spotify app is not in Development Mode restrictions
|
| 84 |
-
|
| 85 |
-
**Groq API Errors:**
|
| 86 |
-
- Verify your API key is correct
|
| 87 |
-
- Check your Groq account has available credits
|
| 88 |
-
- Ensure you have internet connection
|
| 89 |
-
|
| 90 |
-
## Technologies Used
|
| 91 |
-
|
| 92 |
-
- **Streamlit** - Web framework
|
| 93 |
-
- **Groq** - AI/LLM for song recommendations
|
| 94 |
-
- **Spotipy** - Spotify Web API wrapper
|
| 95 |
-
- **Python-dotenv** - Environment variable management
|
| 96 |
-
|
| 97 |
-
## License
|
| 98 |
-
|
| 99 |
-
MIT License - Feel free to use and modify!
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|