Skip to content
Snippets Groups Projects
README.md 1.33 KiB
Newer Older
# FDO Manager Service

**This is WIP - don't use it unless you want to break things.**

Reference implementation of a RESTful Service API for basic FDO operations.
This service exposes the functionality of the
Timm Fitschen's avatar
Timm Fitschen committed
[FDO Manager SDK](https://gitlab.com/fairdo/fdo-manager/sdk).


## Build JAR

```
mvn clean package
```

This results in `application/target/fdo-manager-service.application-${version}.jar`

## Run

Either build the application and start the JAR with

```
java -jar application/target/fdo-manager-service.application-${version}.jar
```

or start it directly from maven with

```
mvn spring-boot:run
```

Timm Fitschen's avatar
Timm Fitschen committed
### Use Mockup Repository

```
mvn -Dmock=true spring-boot:run
```

or 

```
mvn clean package
java -Dmock=true -jar application/target/fdo-manager-service.application-0.1.0-rc6.jar
```

Timm Fitschen's avatar
Timm Fitschen committed
By default you can access the service at `http://localhost:8080/api/`. Try
Timm Fitschen's avatar
Timm Fitschen committed
curl http://localhost:8080/api/hello
Timm Fitschen's avatar
Timm Fitschen committed
### API Specs

You can view the API specs at `http://localhost:8080/api/swagger-ui/index.html`.

### Stop

Stop the running service with `CTRL-C`.


# Contact

* (Lead) Timm Fitschen <t.fitschen@indiscale.com>

# License

AGPL 3.0 or later. <https://www.gnu.org/licenses/agpl-3.0.en.html>

# Copyright

* Copyright (C) 2024 Timm Fitschen <t.fitschen@indiscale.com>
* Copyright (C) 2024 IndiScale GmbH <info@indiscale.com>