MiauRizius/shap-planner-backend
0
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 2 Wiki Activity

adjusted README.md

Browse Source
This commit is contained in:
Maurice L.
2026-02-27 19:36:43 +01:00
parent 859df7819c
commit 6289830732
1 changed files with 10 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@@ -3,43 +3,13 @@
ShAp-Planner 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. The app is fully open source, lightweight, and can run on small devices like Raspberry Pi or older computers.
**Backend:** Go **[Backend](https://git.miaurizius.de/MiauRizius/shap-planner-backend):** Go
**Frontend:** Android (Kotlin) **[Frontend](https://git.miaurizius.de/MiauRizius/shap-planner-android):** Android (Kotlin)
**License:** Unlicense - complete freedom for everyone **[License](https://git.miaurizius.de/MiauRizius/shap-planner-backend/src/branch/main/LICENSE):** [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)
--- ---
## Summary ## Installation
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: 1. Clone the repository:
```bash ```bash
@@ -59,18 +29,15 @@ export SHAP_JWT_SECRET="your_super_random_secret"
go run main.go go run main.go
``` ```
--- ## Configuration
### Environment Variables
## 🧩 Contributing | Variable | Description | Example |
|----------------|-------------------------------------------------------|----------------|
* Fork the repo | `SHAP-JWT_SECRET` | Secret used to sign JWT tokens | `superrandomsecret123` |
* Make changes
* Submit pull requests
We welcome bug fixes, new features, and documentation improvements.
--- ---
## 📜 License ## License
This work is marked <a href="https://creativecommons.org/publicdomain/zero/1.0/">CC0 1.0</a> This work is marked <a href="https://creativecommons.org/publicdomain/zero/1.0/">CC0 1.0</a>