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

Merge pull request #14 from ToneAPI/okvdai

Browse Source 
fix README.md
This commit is contained in:
Legonzaur
2023-04-05 14:52:42 +02:00
committed by GitHub
parent 00aa3e94dc acff144d24
commit 8912c0b7c2
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -3
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/) and [redis](https://redis.io/) 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 `docs` directory
An OpenAPI file is located in `docs` directory.
Alternatively, you can find it converted at https://toneapi.github.io/ToneAPI_backend/