Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 2.41 KB

README.md

File metadata and controls

82 lines (52 loc) · 2.41 KB
Raw

Inrupt RDF Wrapping for Java

Contributor Covenant

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

This project provides an API for wrapping Commons-RDF structures as domain-specific objects.

Using the libraries as a dependency in your own projects

To use the library in your own project you can add the dependency to your build. An example of adding the project in your pom would be:

<properties>
    <inrupt.rdf.wrapping.version>x.x.x</inrupt.rdf.wrapping.version>
</properties>
<dependency>
    <groupId>com.inrupt.rdf</groupId>
    <artifactId>inrupt-rdf-wrapping-commons</artifactId>
    <version>${inrupt.rdf.wrapping.version}</version>
</dependency>

Using this repository locally

After cloning the repository locally you can work with the code as follows:

Code build

The project can be built with Maven and a Java 11+ build environment.

    ./mvnw install

Running tests

The repository contains multiple tests. Each module has dedicated unit tests. By running the following command all tests are run:

    ./mvnw test

Code coverage

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 verify

The reports are then placed in the report/target/site folder on the project root.

Issues & Help

Solid Community Forum

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.

Bugs and Feature Requests

  • 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.

Documentation

Changelog

See the CHANGELOG.md.

License

MIT © Inrupt