Re-Edit the README.md
This commit is contained in:
parent
51b35e32ff
commit
26713dacff
122
README.md
122
README.md
|
|
@ -1,69 +1,107 @@
|
|||
# 🗝️ Steam Key Management System 🔑
|
||||
🗝️ Steam Key Management System 🔑
|
||||
|
||||
**Welcome!** 👋
|
||||
Welcome! 👋
|
||||
|
||||
This project helps you keep track of your collected game keys. Does this sound familiar? You have a key here, a key there, from Humble Bundle, Fanatical, or just given to you, but you can't remember if you redeemed it, gifted it, or if it's still lurking somewhere? Don't panic, this is the solution!
|
||||
This project helps you keep track of your collected game keys.
|
||||
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!
|
||||
|
||||
## ✨ Features ✨
|
||||
✨ Features ✨
|
||||
Key Management:
|
||||
Enter your game keys, the corresponding game, platform, and where you got the key.
|
||||
|
||||
* **Key Management:** Enter your game keys, along with the corresponding game, platform (Steam, GOG, etc.) and where you got the key.
|
||||
* **Status Tracking:** Mark keys as "Redeemed", "Gifted" or "Available". So you always know where you stand.
|
||||
* **Clear Database:** All your keys in one place, easily searchable and sortable.
|
||||
* **(Planned Features):**
|
||||
* Import(?)/Export of Keys (CSV, JSON)
|
||||
* Generate a redeem site with unique link to post it in a mail oder social media
|
||||
Status Tracking:
|
||||
Mark keys as "Redeemed", "Gifted" or "Available" – always know your status.
|
||||
|
||||
## 🚀 Get Started! 🚀
|
||||
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.
|
||||
|
||||
1. **Clone the Repository:**
|
||||
Multi-user:
|
||||
Each user manages their own keys.
|
||||
|
||||
```bash
|
||||
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):
|
||||
|
||||
Import/Export (CSV, JSON)
|
||||
|
||||
Redeem site with unique sharing link
|
||||
|
||||
🚀 Get Started! 🚀
|
||||
1. Clone the Repository
|
||||
bash
|
||||
git clone [Repository URL]
|
||||
cd [Project Directory]
|
||||
```
|
||||
cd steam-gift-manager
|
||||
2. Setup Docker
|
||||
Make sure you have Docker and docker-compose installed.
|
||||
|
||||
2. **Installation (if required - e.g. for a web application):**
|
||||
3. Initial Setup
|
||||
bash
|
||||
chmod +x setup.sh
|
||||
./setup.sh
|
||||
This script prepares all directories, configuration, and translation files.
|
||||
|
||||
* Describe the necessary installation steps here. Example:
|
||||
4. Build and Start the App
|
||||
bash
|
||||
docker-compose build --no-cache
|
||||
docker-compose up -d
|
||||
5. Initialize and Edit Translations (Optional)
|
||||
bash
|
||||
./translate.sh
|
||||
# Edit the .po files in steam-translations/de/LC_MESSAGES/messages.po and en/LC_MESSAGES/messages.po
|
||||
./translate.sh
|
||||
docker-compose restart steam-manager
|
||||
6. Open the App
|
||||
Go to http://localhost:5000 in your browser.
|
||||
|
||||
```bash
|
||||
npm install # Or yarn install, whatever you prefer!
|
||||
```
|
||||
Register your first user.
|
||||
|
||||
3. **Configuration:**
|
||||
Add your keys, shop URLs, and (optionally) Steam AppIDs.
|
||||
|
||||
* Explain here which configuration steps are necessary (e.g. setting up a database connection).
|
||||
* Example: Create a `.env` file and enter your database access data.
|
||||
Enjoy search, status, and automatic Steam cover images!
|
||||
|
||||
4. **Start the Application:**
|
||||
🛠️ Technology Stack 🛠️
|
||||
Frontend: Bootstrap 5, Jinja2 Templates
|
||||
|
||||
```bash
|
||||
npm start # Or however the application is started
|
||||
```
|
||||
Backend: Python 3, Flask, Flask-Babel, Flask-Login, Flask-SQLAlchemy
|
||||
|
||||
5. **Use the Application!** Open your browser and go to `http://localhost:5000` (or wherever your application is running).
|
||||
Database: SQLite (persisted in data/)
|
||||
|
||||
## 🛠️ Technology Stack 🛠️
|
||||
Containerization: Docker, docker-compose
|
||||
|
||||
* **Frontend:** [Static HTML]
|
||||
* **Backend:** [Python/Flask]
|
||||
* **Database:** [SQLite]
|
||||
Translations: Flask-Babel, editable .po files in steam-translations/
|
||||
|
||||
## 🙌 Contribute! 🙌
|
||||
🌍 Multi-language
|
||||
Switch between English and German using the dropdown in the navigation bar.
|
||||
|
||||
This project is open source and thrives on your help! If you find bugs, have suggestions, or want to contribute code yourself, you are welcome!
|
||||
All game and menu texts are translated.
|
||||
|
||||
* **Bug Reports:** Please report bugs as Issues.
|
||||
* **Feature Requests:** Suggest new features!
|
||||
* **Pull Requests:** Submit your code changes!
|
||||
You can add more languages by editing the .po files and running ./translate.sh.
|
||||
|
||||
Before contributing code, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
|
||||
🙌 Contribute! 🙌
|
||||
This project is open source and thrives on your help!
|
||||
|
||||
## 📜 License 📜
|
||||
Bug Reports: Please report bugs as Issues.
|
||||
|
||||
This project is licensed under the [MIT License](LICENSE).
|
||||
Feature Requests: Suggest new features!
|
||||
|
||||
## 💖 Acknowledgements 💖
|
||||
Pull Requests: Submit your code changes!
|
||||
|
||||
Before contributing code, please read the CONTRIBUTING.md file.
|
||||
|
||||
📜 License 📜
|
||||
This project is licensed under the MIT License.
|
||||
|
||||
💖 Acknowledgements 💖
|
||||
A big thank you to everyone who supports and contributes to this project!
|
||||
|
||||
Enjoy your organized Steam key collection! 🚀
|
||||
Loading…
Reference in New Issue