Files
ToneAPI_backend/README.md
T
okvdai acff144d24 fix README.md
remove disclaimer about documentation not being up to date
2023-04-05 14:00:26 +02:00

16 lines
630 B
Markdown

# Stat_Tracker_Server
This is the backend for Tone API.
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
An OpenAPI file is located in `docs` directory.
Alternatively, you can find it converted at https://toneapi.github.io/ToneAPI_backend/