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

Merge branch 'main' of https://github.com/ToneAPI/ToneAPI_backend

Browse Source
This commit is contained in:
legonzaur
2023-04-26 16:28:39 +02:00
parent a7445470ea 029b328272
commit ef3a869189
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -4
View File
@@ -2,15 +2,14 @@
This is the backend for Tone API.
To install the Northstar mod, go [here](https://github.com/Legonzaur/ToneAPI_servermod)
To install the Northstar mod, go [here](https://github.com/Legonzaur/ToneAPI_servermod).
To install, you must have a [postgresql](https://www.postgresql.org/) server. Rename the `.env.example` to `.env` and edit the values.
The serverside and clientside parts are two different executables. You may need a reverse proxy like [nginx](https://www.nginx.com/) or use two different ports.
# Documentation
**DISCLAIMER: DOCUMENTATION ISNT UP TO DATE. WILL UPDATE SOON**
An OpenAPI file is located in `reference/OpenAPI.yml`
An OpenAPI file is located in `docs` directory.
Alternatively, you can find it converted to markdown at [https://legonzaur.github.io/ToneAPI_backend/openapi](https://legonzaur.github.io/ToneAPI_backend/openapi)
Alternatively, you can find it converted at https://toneapi.github.io/ToneAPI_backend/