1.6 KiB
1.6 KiB
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
⚡ 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
- Clone the repository:
git clone https://git.miaurizius.de/MiauRizius/shap-planner-backend.git
cd shap-planner-backend
- Set environment variables:
export SHAP_JWT_SECRET="your_super_random_secret"
- Run the server:
go run main.go
🧩 Contributing
- Fork the repo
- Make changes
- Submit pull requests
We welcome bug fixes, new features, and documentation improvements.
📜 License
This work is marked CC0 1.0