Skip to content

highmobility/hmkit-fleet

Repository files navigation

This is the HMKitFleet v2 branch. See the v1 branch for the previous version.

HMKit Fleet

HMKit Fleet is a Kotlin/Java library that combines different API-s: OAuth, Service Account API and Telematics API to help car companies manage their fleet.

Table of contents

Requirements

  • Target is Java 8
  • Compiled with Kotlin and Java 17

Getting Started

Get started with HMKit Fleet 📘browse the documentation

dependencies {
  implementation('com.high-mobility:hmkit-fleet:{version}')
}

Architecture

General: HMKit Fleet is a Kotlin library that combines 3 different API-s into a single fleet owner package.

Setup

  • git submodule update --init --recursive
  • import the Gradle project
  • run the tests ./gradlew test

Run the sample app

  • Check out the hmkit-fleet-consumer/README.md about how to setup the sample app
  • Run the sample app with ./gradlew :hmkit-fleet-consumer:run

Release/Deployment

check ./gradle/deploy-process.md

License

This repository is using the MIT license. See more in 📘LICENSE

Contributing

Before starting, please read our contribution rules 📘Contributing