ToneAPI/ToneAPI_backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Legonzaur
2023-03-13 20:57:23 +01:00
committed by GitHub
parent fcd1d7d1f0
commit 5c2f2af20f
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6
View File
@@ -7,3 +7,9 @@ To install the Northstar mod, go [here](https://github.com/Legonzaur/ToneAPI_ser
To install, you must have a [postgresql](https://www.postgresql.org/) and [redis](https://redis.io/) server. Rename the `.env.example` to `.env` and edit the values.
The serverside and clientside part are two different executables. You may need a reverse proxy like [nginx](https://www.nginx.com/) or use two different ports.
# Documentation
An OpenAPI file is located in `resources/OpenAPI.yml`
Alternatively, you can find it converted to markdown at [https://legonzaur.github.io/ToneAPI_backend/openapi](https://legonzaur.github.io/ToneAPI_backend/openapi)