Skip to content
This repository has been archived by the owner on Feb 25, 2024. It is now read-only.

comroid-git/guardian-framework

Repository files navigation

The guardian Framework

The guardian Framework aims at enabling a developer to easily create REST-Based APIs, Wrappers for those APIs and even contains a simple module to integrate a Web UI with said API.

Every module of the guardian Framework depends on the comroid common Java API

Gradle and Maven copy-pasta

The guardian Framework is hosted under the comroid repository at maven.comroid.org

Alternatively, it is possible to use the JitPack Pipeline to aquire all modules.

Gradle

repositories {
    maven { url 'https://maven.comroid.org' }
}

Maven

<repositories>
    <repository>
        <id>comroid</id>
        <url>https://maven.comroid.org</url>
    </repository>
</repositories>

Modules

The guardian Framework is composed of a couple of modules, some of which can be used on their own.

All currently available modules are:

Module Short Description Internal Dependencies
mutatio Reference and Reference Pipeline Implementation none
core guardian Core Utilities mutatio
uniform Universal Adapter solution for data types, such as JSON, XML, ... mutatio
varbind uniform and mutatio compatible Databinding solution uniform
restless Client-focused, universal adapter solution for REST-based Actions varbind
webkit Server-focused REST and Website Framework restless
spellbind (currently inoperable) Instance extension using Interface Proxies core