2025-04-22 09:06:32 +00:00
# 🔑 Steam Key Management System v
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00

2025-04-21 11:06:38 +00:00
2025-04-21 13:26:54 +00:00
## Welcome! 👋
2025-04-21 12:41:04 +00:00
This project helps you keep track of your collected game keys.
2025-04-21 12:26:33 +00:00
No more confusion about whether a key is redeemed, gifted, or still unused – now you have everything in one place, with search, status, and even automatic Steam cover images!
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
---
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
## ✨ Features ✨
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
- **Key Management:**
Enter your game keys, the corresponding game, platform, and where you got the key.
- **Status Tracking:**
Mark keys as "Redeemed", "Gifted" or "Available" – always know your status.
- **Shop URL & Steam Cover:**
Save the shop URL and (optionally) the Steam AppID. The app will automatically show the official Steam cover image if available.
- **Multi-user:**
Each user manages their own keys.
- **Search & Filter:**
Find games quickly with the search function.
- **Responsive UI:**
Works on desktop and mobile, with Dark Mode toggle.
- **Multi-language:**
Switch between English and German instantly.
- **No key data leaves your server!**
- **(Planned):**
2025-04-22 09:06:32 +00:00
- Import/Export (CSV, JSON)
- Redeem site with unique sharing link
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
---
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
## 🚀 Get Started! 🚀
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
### 1. **Clone the Repository**
2025-04-22 09:06:32 +00:00
2025-04-21 13:17:28 +00:00
```
2025-04-21 13:24:57 +00:00
git clone https://git.nocci.it/nocci/GiftGamesDB
cd steam-gift-manager
```
2025-04-22 09:06:32 +00:00
2025-04-21 12:41:04 +00:00
### 2. **Setup Docker**
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
Make sure you have [Docker ](https://www.docker.com/ ) and [docker-compose ](https://docs.docker.com/compose/ ) installed.
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
### 3. **Initial Setup**
2025-04-22 09:06:32 +00:00
2025-04-21 13:26:09 +00:00
```
2025-04-21 12:26:33 +00:00
chmod +x setup.sh
./setup.sh
2025-04-21 13:26:09 +00:00
```
2025-04-21 12:41:04 +00:00
2025-04-21 12:26:33 +00:00
This script prepares all directories, configuration, and translation files.
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
### 4. **Build and Start the App**
2025-04-22 09:06:32 +00:00
2025-04-21 13:26:09 +00:00
```
2025-04-21 12:41:04 +00:00
cd steam-gift-manager/
2025-04-21 12:26:33 +00:00
docker-compose build --no-cache
docker-compose up -d
2025-04-21 13:26:09 +00:00
```
2025-04-21 12:41:04 +00:00
### 5. **Initialize and Edit Translations (Optional)**
2025-04-22 09:06:32 +00:00
2025-04-21 13:26:09 +00:00
```
2025-04-21 12:26:33 +00:00
./translate.sh
2025-04-21 13:26:09 +00:00
```
2025-04-22 09:06:32 +00:00
2025-04-21 12:41:04 +00:00
Edit the .po files in steam-translations/de/LC_MESSAGES/messages.po and en/LC_MESSAGES/messages.po
2025-04-22 09:06:32 +00:00
2025-04-21 13:26:09 +00:00
```
2025-04-21 12:26:33 +00:00
./translate.sh
2025-04-21 12:41:04 +00:00
cd steam-gift-manager/
2025-04-21 12:26:33 +00:00
docker-compose restart steam-manager
2025-04-21 13:26:09 +00:00
```
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
### 6. **Open the App**
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
Go to [http://localhost:5000 ](http://localhost:5000 ) in your browser.
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
- Register your first user.
- Add your keys, shop URLs, and (optionally) Steam AppIDs.
- Enjoy search, status, and automatic Steam cover images!
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
---
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
## 🛠️ Technology Stack 🛠️
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
- **Frontend:** Bootstrap 5, Jinja2 Templates
- **Backend:** Python 3, Flask, Flask-Babel, Flask-Login, Flask-SQLAlchemy
- **Database:** SQLite (persisted in `data/` )
- **Containerization:** Docker, docker-compose
- **Translations:** Flask-Babel, editable `.po` files in `steam-translations/`
2025-04-21 11:06:38 +00:00
2025-04-21 12:41:04 +00:00
## 🌍 Multi-language
2025-04-21 12:26:33 +00:00
2025-04-21 12:41:04 +00:00
- Switch between English and German using the dropdown in the navigation bar.
- All game and menu texts are translated.
- You can add more languages by editing the `.po` files and running `./translate.sh` .
2025-04-21 12:26:33 +00:00
2025-04-21 12:41:04 +00:00
---
## 🙌 Contribute! 🙌
2025-04-21 12:26:33 +00:00
This project is open source and thrives on your help!
2025-04-21 12:41:04 +00:00
- **Bug Reports:** Please report bugs as Issues.
- **Feature Requests:** Suggest new features!
- **Pull Requests:** Submit your code changes!
---
2025-04-21 12:26:33 +00:00
2025-04-21 12:41:04 +00:00
## 📜 License 📜
2025-04-21 12:26:33 +00:00
2025-04-21 13:44:17 +00:00
This project is licensed under the [Apache License 2.0 ](LICENSE ).
2025-04-21 12:26:33 +00:00
2025-04-21 12:41:04 +00:00
---
2025-04-21 12:26:33 +00:00
2025-04-21 12:41:04 +00:00
## 💖 Acknowledgements 💖
2025-04-21 12:26:33 +00:00
2025-04-21 11:06:38 +00:00
A big thank you to everyone who supports and contributes to this project!
2025-04-21 12:26:33 +00:00
2025-04-21 12:41:04 +00:00
---
**Enjoy your organized Steam key collection!** 🚀