Files
shap-planner-backend/README.md
2026-02-22 16:37:01 +01:00

1.7 KiB
Raw Blame History

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
  2. Configuration
  3. Setup
  4. Contributing
  5. 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:
git clone https://git.miaurizius.de/MiauRizius/shap-planner-backend.git
cd shap-planner-backend
  1. Set environment variables:
export JWT_SECRET="your_super_random_secret"
  1. 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 project is licensed under The Unlicense it is free for anyone to use, modify, and distribute for any purpose, without restrictions.