This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to engineering@inrupt.com.
The Inrupt Java Client Libraries provide highly flexible, simple components that can be used in any Java application for Solid. The libraries are composed of different modules that follow a layered architectural approach.
To use the Inrupt Java Client Libraries in your projects make sure to visit the Getting Started page of the documentation.
Next we will document how to use this repository locally.
After cloning the repository locally you can work with the code as follows:
The project can be built with Maven and a Java 11+ build environment.
./mvnw installThe repository contains multiple tests. Each module has dedicated unit tests. And there is a module dedicated to integration testing in the integration module. By running the following command all tests (including integration tests) are run:
./mvnw testThe integration tests come with a dedicated Mocked Solid Server. Their configuration can be setup in such a way that the integration tests can be run also on live Solid Servers. More about their setup and configuration can be found on the integration test README.
This project uses JaCoCo for generating the code coverage metric that measures how many lines of code are executed during automated tests. To generate the reports (in different formats) run:
./mvnw verifyThe reports are then placed in the report/target/site folder on the project root.
If you have questions about working with Solid or just want to share what you’re working on, visit the Solid forum. The Solid forum is a good place to meet the rest of the community.
- For public feedback, bug reports, and feature requests please file an issue via Github.
- For non-public feedback or support inquiries please use the Inrupt Service Desk.
See the Release notes
MIT © Inrupt