Add Readme
This commit is contained in:
27
README.md
27
README.md
@@ -0,0 +1,27 @@
|
||||
# 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.
|
||||
|
||||
## License
|
||||
This project is licensed under the [European Union Public Licence (EUPL)](https://joinup.ec.europa.eu/collection/eupl).
|
||||
|
||||
Reference in New Issue
Block a user