Skip to content
Snippets Groups Projects
README.md 1.06 KiB
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`
Marco Holz's avatar
Marco Holz committed
### Tests
Martin Vogel's avatar
Martin Vogel committed
To run all tests, run: `mvn test`

Martin Vogel's avatar
Martin Vogel committed
### How to use
The sdk provides a client that guides through all steps for sending and receiving submission. For further details 
see the [SDK client](https://git.fitko.de/fit-connect/sdk-java/-/tree/feature/414-sdk-methoden-signaturen/client) 
documentation.

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:

Marco Holz's avatar
Marco Holz committed
* [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/)