new file: .env.example
modified: README.md
This commit is contained in:
10
.env.example
Normal file
10
.env.example
Normal file
@@ -0,0 +1,10 @@
|
||||
# Spotify API Credentials
|
||||
SPOTIPY_CLIENT_ID=deine_spotify_client_id
|
||||
SPOTIPY_CLIENT_SECRET=dein_spotify_client_secret
|
||||
SPOTIPY_REDIRECT_URI=http://localhost:5000/callback
|
||||
|
||||
# Flask Secret Key
|
||||
SECRET_KEY=dein_geheimer_flask_key
|
||||
|
||||
# Flask Umgebung (optional)
|
||||
FLASK_ENV=development
|
||||
59
README.md
59
README.md
@@ -0,0 +1,59 @@
|
||||
# Quizify – Musik Quiz mit Spotify
|
||||
|
||||
Quizify ist ein Musik-Quiz, das deine Spotify-Playlists nutzt. Errate Künstler, Titel oder Erscheinungsjahr von Songs aus deinen eigenen Playlists – direkt im Browser!
|
||||
|
||||
## Features
|
||||
|
||||
- Login mit Spotify
|
||||
- Auswahl deiner eigenen Playlists
|
||||
- Verschiedene Spielmodi: Künstler, Titel oder Jahr erraten
|
||||
- Spotify Web Playback (direktes Abspielen im Browser)
|
||||
- Keine Songwiederholungen bis alle gespielt wurden
|
||||
- Intelligente Suche und Antwortauswertung (ignoriert Klammerzusätze etc.)
|
||||
|
||||
## Voraussetzungen
|
||||
|
||||
- Python 3.10 oder neuer
|
||||
- Spotify Developer Account ([developer.spotify.com](https://developer.spotify.com/))
|
||||
- Spotify Premium Account (für Web Playback)
|
||||
- Die Umgebungsvariablen müssen gesetzt sein (siehe `.env.example`)
|
||||
|
||||
## Installation
|
||||
|
||||
1. **Repository klonen**
|
||||
```sh
|
||||
git clone https://github.com/dein-benutzername/quizify.git
|
||||
cd quizify
|
||||
```
|
||||
|
||||
2. **.env Datei anlegen**
|
||||
Kopiere `.env.example` zu `.env` und trage deine Spotify-API-Daten ein.
|
||||
|
||||
3. **Starten unter Windows**
|
||||
```sh
|
||||
start.bat
|
||||
```
|
||||
|
||||
Alternativ manuell:
|
||||
```sh
|
||||
python -m venv ven
|
||||
ven\Scripts\activate
|
||||
pip install -r requirements.txt
|
||||
python app.py
|
||||
```
|
||||
|
||||
4. **Im Browser öffnen**
|
||||
- [http://localhost:5000](http://localhost:5000)
|
||||
|
||||
## .env Beispiel
|
||||
|
||||
Siehe `.env.example` für die nötigen Variablen.
|
||||
|
||||
## Hinweise
|
||||
|
||||
- Die App benötigt einen Spotify Premium Account für die Web Playback-Funktion.
|
||||
- Die Spotify Redirect URI muss in der Spotify Developer Console exakt mit `SPOTIPY_REDIRECT_URI` übereinstimmen.
|
||||
|
||||
## Lizenz
|
||||
|
||||
MIT License
|
||||
Reference in New Issue
Block a user