Skip to content

NoriginMedia/nannoq-web

Repository files navigation

DISCONTINUED JAVA LEGACY - Use Kotlin version @ Nannoq-Tools

Nannoq Web

Build Status

nannoq-web is a REST (Level 3) controller implementation that is based on vertx-web and leverages nannoq-repository for data store access.

It incorporates:

  • ETag
  • Clustered Caching through nannoq-repository

It supports:

  • Filtering
  • Ordering
  • Projections
  • Grouping
  • Aggregations
  • Cross-Model Aggregations

Prerequisites

Vert.x >= 3.5.0

Java >= 1.8

Maven

nannoq-repository

Installing

mvn clean package -Dgpg.skip=true

Running the tests

mvn clean test -Dgpg.skip=true

Running the integration tests

mvn clean verify -Dgpg.skip=true

Usage

First install with either Maven:

<dependency>
    <groupId>com.nannoq</groupId>
    <artifactId>web</artifactId>
    <version>1.0.5</version>
</dependency>

or Gradle:

dependencies {
    compile group: 'nannoq.com:web:1.0.5’
}

Implementation and Querying

Please consult the Wiki for guides on implementations and queries on the controller.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details