70 lines
2.4 KiB
Markdown
70 lines
2.4 KiB
Markdown
# 🗝️ Steam Key Management System 🔑
|
|
|
|
|
|
**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!
|
|
|
|
## ✨ Features ✨
|
|
|
|
* **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
|
|
|
|
## 🚀 Get Started! 🚀
|
|
|
|
1. **Clone the Repository:**
|
|
|
|
```bash
|
|
git clone [Repository URL]
|
|
cd [Project Directory]
|
|
```
|
|
|
|
2. **Installation (if required - e.g. for a web application):**
|
|
|
|
* Describe the necessary installation steps here. Example:
|
|
|
|
```bash
|
|
npm install # Or yarn install, whatever you prefer!
|
|
```
|
|
|
|
3. **Configuration:**
|
|
|
|
* 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.
|
|
|
|
4. **Start the Application:**
|
|
|
|
```bash
|
|
npm start # Or however the application is started
|
|
```
|
|
|
|
5. **Use the Application!** Open your browser and go to `http://localhost:5000` (or wherever your application is running).
|
|
|
|
## 🛠️ Technology Stack 🛠️
|
|
|
|
* **Frontend:** [Static HTML]
|
|
* **Backend:** [Python/Flask]
|
|
* **Database:** [SQLite]
|
|
|
|
## 🙌 Contribute! 🙌
|
|
|
|
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!
|
|
|
|
* **Bug Reports:** Please report bugs as Issues.
|
|
* **Feature Requests:** Suggest new features!
|
|
* **Pull Requests:** Submit your code changes!
|
|
|
|
Before contributing code, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
|
|
|
|
## 📜 License 📜
|
|
|
|
This project is licensed under the [MIT License](LICENSE).
|
|
|
|
## 💖 Acknowledgements 💖
|
|
|
|
A big thank you to everyone who supports and contributes to this project!
|