36 lines
855 B
Markdown
36 lines
855 B
Markdown
# Allmende Payment System
|
|
|
|
A FastAPI-based payment system for the communal living projects and similar groups.
|
|
|
|
## Prerequisites
|
|
- [uv](https://docs.astral.sh/uv/) (package and dependency manager)
|
|
|
|
## Getting Started
|
|
|
|
### 1. Install uv
|
|
Ensure `uv` is installed. If not, follow the [official installation guide](https://docs.astral.sh/uv/getting-started/installation/).
|
|
|
|
### 2. Initialize the database
|
|
|
|
```bash
|
|
make reset_db
|
|
```
|
|
Resets the database and initializes it with some mock data.
|
|
|
|
### 3. Run the Development Server
|
|
```bash
|
|
uv run fastapi dev src/allmende_payment_system/app.py
|
|
```
|
|
A demo user will be created automatically.
|
|
|
|
### Testing
|
|
|
|
APS uses pytest. You can run the test suite with:
|
|
|
|
```bash
|
|
uv run pytest
|
|
```
|
|
|
|
## License
|
|
This project is licensed under the [European Union Public Licence (EUPL)](https://joinup.ec.europa.eu/collection/eupl).
|