From 9572aa59cab04767ce61c8da026425a9821c91c1 Mon Sep 17 00:00:00 2001 From: MiauRizius Date: Sun, 22 Feb 2026 16:32:10 +0100 Subject: [PATCH 1/6] =?UTF-8?q?README.md=20hinzugef=C3=BCgt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6a7e7ab --- /dev/null +++ b/README.md @@ -0,0 +1,76 @@ +# ShAp-Planner + +WGTracker is a **self-hosted app** for managing finances, tasks, and data within shared households. +The app is fully open source, lightweight, and can run on small devices like Raspberry Pi or older computers. + +**Backend:** Go +**Frontend:** Android (Kotlin) +**License:** Unlicense - complete freedom for everyone + +--- + +## Summary +1. [Features](#features) +2. [Configuration](#configuration) +3. [Setup](#setup) +4. [Contributing](#contributing) +5. [License](#license) + +--- + +## ⚡ Features + +- Multi-account support +- JWT-based login system +- Role-based access control (user/admin) +- Self-hosted, lightweight backend +- Configuration via environment variables +- Easy to extend with custom modules + +--- + +## ⚙️ Configuration + +### Environment Variables + +| Variable | Description | Example | +|----------------|-------------------------------------------------------|----------------| +| `JWT_SECRET` | Secret used to sign JWT tokens | `superrandomsecret123` | + +--- + +## 📝 Setup + +1. Clone the repository: +```bash +git clone https://git.miaurizius.de/MiauRizius/shap-planner-backend.git +cd shap-planner-backend +```` + +2. Set environment variables: + +```bash +export JWT_SECRET="your_super_random_secret" +``` + +3. Run the server: + +```bash +go run main.go +``` + +--- + +## 🧩 Contributing + +* Fork the repo +* Make changes +* Submit pull requests + +We welcome bug fixes, new features, and documentation improvements. + +--- + +## 📜 License + +This project is licensed under **[The Unlicense](https://unlicense.org/)** – it is free for anyone to use, modify, and distribute for any purpose, without restrictions. \ No newline at end of file From b2b100b238e51f3e4fa24638571f4d0d84481eae Mon Sep 17 00:00:00 2001 From: MiauRizius Date: Sun, 22 Feb 2026 16:33:04 +0100 Subject: [PATCH 2/6] README.md aktualisiert --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6a7e7ab..ed179d2 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,11 @@ The app is fully open source, lightweight, and can run on small devices like Ras --- ## Summary -1. [Features](#features) -2. [Configuration](#configuration) -3. [Setup](#setup) -4. [Contributing](#contributing) -5. [License](#license) +1. [Features](#-features) +2. [Configuration](#-configuration) +3. [Setup](#-setup) +4. [Contributing](#-contributing) +5. [License](#-license) --- From f578288c910fd21ced9a14f2b19b0e97677599a6 Mon Sep 17 00:00:00 2001 From: MiauRizius Date: Sun, 22 Feb 2026 16:35:20 +0100 Subject: [PATCH 3/6] =?UTF-8?q?LICENSE.md=20hinzugef=C3=BCgt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- LICENSE.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..c32dd18 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,24 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +For more information, please refer to \ No newline at end of file From 971325f1f29c545eb1bf803d1cfa86ef55dba05c Mon Sep 17 00:00:00 2001 From: MiauRizius Date: Sun, 22 Feb 2026 16:37:01 +0100 Subject: [PATCH 4/6] README.md aktualisiert --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ed179d2..3214529 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ShAp-Planner -WGTracker is a **self-hosted app** for managing finances, tasks, and data within shared households. +ShAp-Planner is a **self-hosted app** for managing finances, tasks, and data within shared households. The app is fully open source, lightweight, and can run on small devices like Raspberry Pi or older computers. **Backend:** Go From 8f6764420f7db2ed4eab517ebf08f3716e8a05aa Mon Sep 17 00:00:00 2001 From: MiauRizius Date: Sun, 22 Feb 2026 16:47:27 +0100 Subject: [PATCH 5/6] README.md aktualisiert --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3214529..c150f14 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ The app is fully open source, lightweight, and can run on small devices like Ras | Variable | Description | Example | |----------------|-------------------------------------------------------|----------------| -| `JWT_SECRET` | Secret used to sign JWT tokens | `superrandomsecret123` | +| `SHAP-JWT_SECRET` | Secret used to sign JWT tokens | `superrandomsecret123` | --- From e74573c6d4c93b5c300b94b3859a2799005af30d Mon Sep 17 00:00:00 2001 From: MiauRizius Date: Sun, 22 Feb 2026 20:15:04 +0100 Subject: [PATCH 6/6] README.md aktualisiert --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c150f14..3cca46b 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ cd shap-planner-backend 2. Set environment variables: ```bash -export JWT_SECRET="your_super_random_secret" +export SHAP_JWT_SECRET="your_super_random_secret" ``` 3. Run the server: