Files
allmende-payment-system/README.md
2026-06-29 16:28:22 +02:00

1.1 KiB

Allmende Payment System

A FastAPI-based payment system for the communal living projects and similar groups.

Prerequisites

  • uv (package and dependency manager)

Getting Started

1. Install uv

Ensure uv is installed. If not, follow the official installation guide.

2. Initialize the database

make reset_db

Resets the database and initializes it with some mock data.

3. Run the Development Server

uv run fastapi dev src/allmende_payment_system/app.py

A demo user will be created automatically.

Configuration

A preliminary config system exists and works via environment variables:

* APS_READ_ONLY: If set, users can make no purchases
* APS_PRODUCTION_MODE: If set, demo functionality, like adding money to an account and the demo banner are removed.

Testing

APS uses pytest. You can run the test suite with:

uv run pytest

License

This project is licensed under the European Union Public Licence (EUPL).