modified: README.md

This commit is contained in:
SimolZimol
2025-05-19 20:19:23 +02:00
parent a8ceb02d9a
commit e278e54541

View File

@@ -7,10 +7,12 @@ Quizify is a music quiz that uses your Spotify playlists. Guess the artist, titl
- Login with Spotify
- Select your own playlists
- Multiple game modes: Guess artist, title, or year
- Adjustable play duration and random start position for each song
- Spotify Web Playback (play songs directly in the browser)
- No song repeats until all have been played
- Smart search and answer evaluation (ignores bracket additions, apostrophes, etc.)
- Multilingual: All texts are loaded from language files, language is set via `.env`
- Dockerfile included ready for deployment with [Coolify](https://coolify.io/) or any Docker-compatible platform
## Requirements
@@ -46,6 +48,21 @@ Quizify is a music quiz that uses your Spotify playlists. Guess the artist, titl
4. **Open in your browser**
- [http://localhost:5000](http://localhost:5000)
## Docker / Coolify
Quizify comes with a ready-to-use `Dockerfile`.
You can deploy it on [Coolify](https://coolify.io/) or any Docker-compatible platform.
**Build and run locally:**
```sh
docker build -t quizify .
docker run --env-file .env -p 5000:5000 quizify
```
**Coolify:**
Just connect your repository, set your environment variables in Coolify, and deploy.
The app will be available on port 5000 by default.
## .env Example
See `.env.example` for the required variables.
@@ -55,6 +72,7 @@ See `.env.example` for the required variables.
- The app requires a Spotify Premium account for the Web Playback feature.
- The Spotify Redirect URI must exactly match `SPOTIPY_REDIRECT_URI` in the Spotify Developer Console.
- All texts are loaded from language files in the `locales` folder. Set the language via the `LANG` variable in your `.env` (e.g., `LANG=en-EN` or `LANG=de-DE`).
- You can set the play duration and start position for each song in the quiz interface.
## License