mirror of
https://github.com/arcan1s/ffxivbis.git
synced 2025-04-25 01:37:17 +00:00
Evgeniy Alekseev
ad144534a9
* types api * dist instead of assembly (assembly does not allow to use swagger easily) * small swagger improvements
29 lines
651 B
Markdown
29 lines
651 B
Markdown
# FFXIV BiS
|
|
|
|
Service which allows to manage savage loot distribution easy.
|
|
|
|
## Installation and usage
|
|
|
|
In general compliation process looks like:
|
|
|
|
```bash
|
|
sbt dist
|
|
```
|
|
|
|
Or alternatively you can download latest distribution zip from the releases page. Service can be run by using command:
|
|
|
|
```bash
|
|
bin/ffxivbis
|
|
```
|
|
|
|
from the extracted archive root.
|
|
|
|
## Web service
|
|
|
|
REST API documentation is available at `http://0.0.0.0:8000/swagger`. HTML representation is available at `http://0.0.0.0:8000`.
|
|
|
|
*Note*: host and port depend on configuration settings.
|
|
|
|
## Public service
|
|
|
|
There is also public service which is available at https://ffxivbis.arcanis.me. |