Skip to content
Snippets Groups Projects
README.md 903 B
Newer Older
Martin Vogel's avatar
Martin Vogel committed
## FIT-Connect Java SDK
Martin Vogel's avatar
Martin Vogel committed

### Project Setup Info
Martin Vogel's avatar
Martin Vogel committed
- Java 11 (LTS)
- Maven
- Junit 5
Martin Vogel's avatar
Martin Vogel committed
- (Guice DI)
Martin Vogel's avatar
Martin Vogel committed
### Build

To build the maven artifact, run: `mvn clean package`
Martin Vogel's avatar
Martin Vogel committed
####
Martin Vogel's avatar
Martin Vogel committed
To run all tests, run: `mvn test`

Martin Vogel's avatar
Martin Vogel committed
### External Configuration
Martin Vogel's avatar
Martin Vogel committed

Configuration properties e.g. for REST-API urls and proxy settings can be found in
the [HOCON](https://github.com/lightbend/config/blob/main/HOCON.md)
config ``sdk.conf`` within the root folder of the project.
Martin Vogel's avatar
Martin Vogel committed

Martin Vogel's avatar
Martin Vogel committed
### Documentation
See the projects module documentation for more specific information:

* [API Module ](api/README.md)
* [Core Module ](core/README.md)
* [Client Module ](client/README.md)
* [Dependency Module ](dependency/README.md)
* [Open-API Module ](open-api/README.md)
Martin Vogel's avatar
Martin Vogel committed
As well as the official API docs: [FIT-Connect Documentation](https://docs.fitko.de/fit-connect/docs/)
Martin Vogel's avatar
Martin Vogel committed

### Self Service Portal (DEV)
Martin Vogel's avatar
Martin Vogel committed
https://portal.auth-dev.fit-connect.fitko.dev/
Martin Vogel's avatar
Martin Vogel committed