Merge remote-tracking branch 'origin/main'

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 <https://unlicense.org/>

README.md

@@ -0,0 +1,76 @@
+# ShAp-Planner
+
+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  
+**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          |
+|----------------|-------------------------------------------------------|----------------|
+| `SHAP-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 SHAP_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.