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: CC0 1.0

Installation

Docker Compose (recommended)

Download docker-compose.yaml

$ curl -L https://git.miaurizius.de/MiauRizius/shap-planner-backend/raw/branch/main/docker-compose.yaml -o docker-compose.yaml

or create it yourself and enter the following content

services:
  shap-planner:
    image: git.miaurizius.de/miaurizius/shap-planner-backend:latest
    container_name: shap-planner
    restart: unless-stopped
    ports:
      - "8080:8080"
    environment:
      - SHAP_JWT_SECRET=SECURE_RANDOM_STRING # Must be at least 32 characters long
    volumes:
      - ./appdata:/appdata # To edit your configuration files

Start the container

$ docker compose up -d

Edit configuration as you like

Build from source

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

Configuration

Environment Variables

Variable	Description	Example
`SHAP_JWT_SECRET`	Secret used to sign JWT tokens	`superrandomsecret123`

License

This work is marked CC0 1.0