diff --git a/README.md b/README.md index 440d997..3e7fe97 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# 🗝️ Steam Key Management System 🔑 +# 🔑 Steam Key Management System v ![Screenshot](GameManager.png) @@ -27,23 +27,26 @@ No more confusion about whether a key is redeemed, gifted, or still unused – n Switch between English and German instantly. - **No key data leaves your server!** - **(Planned):** - - Import/Export (CSV, JSON) - - Redeem site with unique sharing link + - Import/Export (CSV, JSON) + - Redeem site with unique sharing link --- ## 🚀 Get Started! 🚀 ### 1. **Clone the Repository** + ``` git clone https://git.nocci.it/nocci/GiftGamesDB cd steam-gift-manager ``` + ### 2. **Setup Docker** Make sure you have [Docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/) installed. ### 3. **Initial Setup** + ``` chmod +x setup.sh ./setup.sh @@ -52,6 +55,7 @@ chmod +x setup.sh This script prepares all directories, configuration, and translation files. ### 4. **Build and Start the App** + ``` cd steam-gift-manager/ docker-compose build --no-cache @@ -59,10 +63,13 @@ docker-compose up -d ``` ### 5. **Initialize and Edit Translations (Optional)** + ``` ./translate.sh ``` + Edit the .po files in steam-translations/de/LC_MESSAGES/messages.po and en/LC_MESSAGES/messages.po + ``` ./translate.sh cd steam-gift-manager/ @@ -87,7 +94,6 @@ Go to [http://localhost:5000](http://localhost:5000) in your browser. - **Containerization:** Docker, docker-compose - **Translations:** Flask-Babel, editable `.po` files in `steam-translations/` - ## 🌍 Multi-language - Switch between English and German using the dropdown in the navigation bar.