docs: add IGDB setup guide, .env.example, and .gitignore for public release
Build & Deploy / build-and-deploy (push) Successful in 14s

- Add .env.example with Twitch credential instructions
- Update docker-compose.yml to use env_file instead of inline comments
- Add IGDB Metadata section to README with setup walkthrough
- Add .env / .env.local to .gitignore to prevent secret leaks
This commit is contained in:
Hermes Agent
2026-06-10 16:29:50 +02:00
parent 0f635ad476
commit 7cc5bddf73
4 changed files with 53 additions and 6 deletions
+37 -3
View File
@@ -4,14 +4,29 @@ A nostalgic DOS game hub. Upload your old DOS games, scrape artwork, and play th
## Quick Start
### With Docker Compose (easiest)
```bash
# Build and run with Docker
docker build -t dostalgia .
docker run -p 8765:8765 -v $(pwd)/data:/data dostalgia
# 1. (Optional) Enable IGDB metadata auto-scrape
cp .env.example .env
# Edit .env with your Twitch credentials (see IGDB section below)
# 2. Build & run
docker compose up -d
```
Open http://localhost:8765
### With Docker
```bash
docker build -t dostalgia .
docker run -p 8765:8765 -v $(pwd)/data:/data \
-e TWITCH_CLIENT_ID=your_id \
-e TWITCH_CLIENT_SECRET=your_secret \
dostalgia
```
## Development (without Docker)
Terminal 1 — Frontend dev server:
@@ -66,3 +81,22 @@ java -jar target/quarkus-app/quarkus-run.jar
"ready": true
}
```
## IGDB Metadata (Optional)
Dostalgia can auto-populate game metadata (year, genre, developer, cover art, screenshots, videos) from the [IGDB](https://www.igdb.com/) database. This requires a Twitch API application.
**Setup:**
1. Go to https://dev.twitch.tv/console/apps → **Register Your Application**
2. Name: `Dostalgia` (or anything), OAuth Redirect URL: `http://localhost`, Category: **Other**
3. Copy the **Client ID** and generate a **Client Secret**
4. Provide them via environment variables:
| Method | How |
|--------|-----|
| Docker run | `-e TWITCH_CLIENT_ID=xxx -e TWITCH_CLIENT_SECRET=yyy` |
| Docker Compose | Copy `.env.example` to `.env` and fill in the values |
| Local dev | `export TWITCH_CLIENT_ID=xxx TWITCH_CLIENT_SECRET=yyy` |
IGDB features degrade gracefully — if credentials aren't set, uploads and metadata editing still work, just without auto-scrape.