mirror of
https://github.com/arcan1s/ffxivbis.git
synced 2025-07-15 14:55:49 +00:00
0.9.4
* types api * dist instead of assembly (assembly does not allow to use swagger easily) * small swagger improvements
This commit is contained in:
14
README.md
14
README.md
@ -4,20 +4,26 @@ Service which allows to manage savage loot distribution easy.
|
||||
|
||||
## Installation and usage
|
||||
|
||||
In general installation process looks like:
|
||||
In general compliation process looks like:
|
||||
|
||||
```bash
|
||||
sbt assembly
|
||||
sbt dist
|
||||
```
|
||||
|
||||
Or alternatively you can download latest jar from releases page. Service can be run by using command:
|
||||
Or alternatively you can download latest distribution zip from the releases page. Service can be run by using command:
|
||||
|
||||
```bash
|
||||
java -cp ./target/scala-2.13/ffxivbis-scala-assembly-0.1.jar me.arcanis.ffxivbis.ffxivbis
|
||||
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.
|
Reference in New Issue
Block a user