doc: README

This commit is contained in:
eneller
2026-07-23 17:21:31 +02:00
parent cb9728a90b
commit e8f8cfbe99
5 changed files with 17 additions and 2 deletions

View File

@@ -1,6 +1,17 @@
# FakeMoney
A PayPal-like payment processor for virtual money, intended to be used for simulation games.
**A PayPal-like payment processor for virtual money, intended to be used for [simulation games](https://de.wikipedia.org/wiki/Schule_als_Staat).**
Send and receive money from your account and businesses you own using simple URLs and QR codes.
Install as a [PWA](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps)
from your browser (Firefox/Chrome/Safari) with just 3 taps and bypass tedious app store processes.
<img src="docs/img/screenshot-login.png" width="32%" alt="Login view">&nbsp;
<img src="docs/img/screenshot-send.png" width="32%" alt="Send view">&nbsp;
<img src="docs/img/screenshot-receive.png" width="32%" alt="Receive view">&nbsp;
## Deployment
Is simplified using Docker and by making a few assumptions, e.g. that API and frontend are available under the same domain.
## Development
### Frontend

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

View File

@@ -1,3 +1,4 @@
import Account from "../model/user";
export class LoginRequest{
constructor(
public username: string,
@@ -5,5 +6,8 @@ export class LoginRequest{
){}
}
export class LoginResponse{
constructor(){}
constructor(
public user: Account,
public ownedBusinesses: Account[],
){}
}