Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gluonhq/attach

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/gluonhq/attach
Owner: gluonhq
License: gpl-3.0
Created: 2019-02-06T13:38:06.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-12-11T09:50:35.000Z (16 days ago)
Last Synced: 2024-12-15T18:08:39.157Z (11 days ago)
Language: Java
Size: 1.54 MB
Stars: 49
Watchers: 11
Forks: 28
Open Issues: 61
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Gluon Attach #

[![Maven Central](https://img.shields.io/maven-central/v/com.gluonhq.attach/util)](https://search.maven.org/search?q=g:com.gluonhq.attach%20AND%20a:util)

[![Github Actions](https://github.com/gluonhq/attach/workflows/Attach%20Build/badge.svg)](https://github.com/gluonhq/attach/actions?query=workflow%3A%Attach+Build%22)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

Gluon [Attach](http://gluonhq.com/products/mobile/attach/) is the component that addresses the integration with low-level platform APIs in an end-to-end Java Mobile solution.

Attach provides an uniform, platform-independent API to access device and hardware features. 

At runtime, the appropriate implementation (attach:desktop, attach:android, attach:ios) makes sure the platform specific code is 

used to deliver the functionality.

Attach is open source, and it is freely licensed under the GPL license.

[Gluon](http://gluonhq.com) can provide [custom consultancy](http://gluonhq.com/services/consulting/) and [training](http://gluonhq.com/services/training/), commercial licenses, and open source [commercial support](http://gluonhq.com/services/commercial-support/), including daily and monthly releases.

## Getting started ##

The best way to get started with Gluon Attach is using the [GluonFX Maven archetype from your IDE](https://github.com/gluonhq/gluonfx-maven-archetypes)

and creating a [Gluon Mobile](http://gluonhq.com/products/mobile) project.

The [Gluon samples](https://github.com/gluonhq/gluon-samples) are a good way to find out how Attach is used.

See the [documentation](https://docs.gluonhq.com/#_attach_with_gluonfx_plugin) on how to add Attach with the GluonFX Plugin.

The [JavaDoc](https://docs.gluonhq.com/attach/javadoc/latest/) contains the reference documentation for the Attach API's.

The list of available services at Attach can be found [here](http://gluonhq.com/products/mobile/attach/).

## Building Attach ##

Gluon Attach is frequently released, and this is only required in case you want to fork and build your local version of Attach.

### Requisites ###

These are the requisites:

* A recent version of [JDK 11](http://jdk.java.net/11/)

* Gradle 6.0 or superior. 

To build the iOS Services:

 

* A Mac with with MacOS X 11 or superior

* XCode 11.x or superior

### How to build and install Attach ###

To build the Attach services on the project's root, run:

`./gradlew clean build`

If you want to install them, run:

`./gradlew clean publishToMavenLocal`

When the process finishes successfully, the different services can be added to a Gluon Mobile project.

For instance, the Display service for desktop can be added to the project like:

```

    com.gluonhq.attach

    display

    4.0.9-SNAPSHOT

    

        display

    

```

## Issues and Contributions ##

Issues can be reported to the [Issue tracker](https://github.com/gluonhq/attach/issues)

Contributions can be submitted via [Pull requests](https://github.com/gluonhq/attach/pulls), 

 providing you have signed the [Gluon Individual Contributor License Agreement (CLA)](https://docs.google.com/forms/d/16aoFTmzs8lZTfiyrEm8YgMqMYaGQl0J8wA0VJE2LCCY).