🤹‍♀️ mULti4J

A Java Wrapper for the Université de Lorraine "mULti" web application GQL API (multi.univ-lorraine.fr)

Table of contents

• 🔧 Installation
  • 👁️ Prerequisites
  • 🧨 Maven
  • 🛞 Gradle
• 📖 Wiki

🔧 Installation

👁️ Prerequisites

First, you will need to authenticate to GitHub Packages to be able to download the package.

⚠️ Warning: This step is very important, please read the documentation carefully. You'll need to create a personal access token with the read:packages scope.

Authentication is different depending on the build tool you use, here are the links to the documentation:

• Authentication with Maven
• Authentication with Gradle

🧨 Maven

1. Add the following to your pom.xml repositories section:

<repository>
    <id>github</id>
    <url>https://maven.pkg.github.com/MAXOUXAX/mULti4J</url>
    <snapshots>
        <enabled>true</enabled>
    </snapshots>
</repository>

2. And to the dependencies section:

<dependency>
    <groupId>me.maxouxax.multi4j</groupId>
    <artifactId>multi4j</artifactId>
    <version>1.0.0</version>
</dependency>

🛞 Gradle

1. Add the following to your build.gradle repositories section:

repositories {
    maven {
        name = "GitHubPackages"
        url = uri("https://maven.pkg.github.com/MAXOUXAX/mULti4J")
        credentials {
            username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
            password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
        }
    }
}

2. And to the dependencies section:

dependencies {
    implementation 'me.maxouxax.multi4j:multi4j:1.0.0'
}

📖 Wiki / Documentation

The wiki / documentation is available here