AfRA/AfRApay
3
0
Fork 0
Code Issues 7 Pull requests Packages Projects Releases Wiki Activity

Add AfRApay.Web dev environment documentation

Browse source
This commit is contained in:
Laura Hausmann 2023-02-10 02:50:02 +01:00
parent 3c85405364
commit b308a6bfea
Signed by: zotan
GPG key ID: D044E84C5BE01605
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
AfRApay.Web/README.md Normal file
View file

@ -0,0 +1,9 @@
# AfRApay.MateCard
This is the software that runs on the MateCard terminal, powered by an ESP32.
## Setting up dev environment
This project uses PlatformIO. Quick setup guide:
- Install dotnet-sdk (macOS: `brew install dotnet-sdk` / Arch Linux: `pacman -S dotnet-host dotnet-runtime dotnet-sdk dotnet-targeting-pack aspnet-runtime aspnet-targeting-pack`)
- To start the webserver, execute `dotnet run` in this directory.
- Swagger / OpenAPI docs will automatically generate at `/swagger`.
- To test with the MateCard ESP32 code, get your computer's IP and configure the ESP to use `http://<yourip>:5296` as the API base url.