Skip to content

README.md

Latest commit

 

History

History
104 lines (67 loc) · 3.12 KB

README.md

File metadata and controls

104 lines (67 loc) · 3.12 KB

Eclipse Kura™

Kura™ logo

Applications for Eclipse Kura™ framework

In this repository you can find some application that can be installed on an Eclipse Kura™ instance.

What Applications for Eclipse Kura™ can I build?

  • Kura™ Examples: provides examples of component that can be developed for the Eclipse Kura™ framework.
  • Kura™ Prototypes: provides prototypes of components that can be developed for the Eclipse Kura™ framework.

Build

For the complete guide to setup the development environment, please refer to the Eclipse Kura™ documentation.

Prerequisites

In order to be able to build the applications for Eclipse Kura™ on your development machine, you need to have the following programs installed in your system:

  • JDK 21
  • Maven 3.9.9 or higher

Installing Mandatory Programs in Mac OS

To install Java 21, download the JDK tar archive from the Adoptium Project Repository.

Once downloaded, copy the tar archive in /Library/Java/JavaVirtualMachines/ and cd into it. Unpack the archive with the following command:

sudo tar -xzf <archive-name>.tar.gz

The tar archive can be deleted afterwards.

Depending on which terminal you are using, edit the profiles (.zshrc, .profile, .bash_profile) to contain:

export JAVA_HOME=/Library/Java/JavaVirtualMachines/<archive-name>/Contents/Home

Reload the terminal and run java -version to make sure it is installed correctly.

Using Brew you can easily install Maven from the command line:

brew install [email protected]

Run mvn -version to ensure that Maven has been added to the PATH. If Maven cannot be found, try running brew link [email protected] --force or manually add it to your path with:

export PATH="/usr/local/opt/[email protected]/bin:$PATH"

Installing Mandatory Programs in Linux

For Java

sudo apt install openjdk-21-jdk

For Maven

You can follow the tutorial from the official Maven site. Remember that you need to install the 3.9.9 or higher version.

Build the Applications for Eclipse Kura™

Change to the new directory and clone the Applications Eclipse Kura™ repo:

git clone https://github.com/eclipse-kura/kura-apps.git

Build the project:

mvn clean install

Tip

You can skip tests by adding -Dmaven.test.skip=true in the commands above.

The Debian installers for the examples and prototypes will be generated in the kura-apps-distrib directory, under kura-examples/target/deb and kura-addon-prototypes/target/deb respectively.

Contributing

Contributing to the Applications for Eclipse Kura™ is fun and easy! To start contributing you can follow our guide here.