Developer Guide: Preparing the environment

To build OpenRemote projects, you have to first prepare the environment on your developer workstation or build machine.

Ensure you have installed and configured the following tools:

Runtime tooling

To run docker images from Docker Hub you need to install the following tooling:

• Docker see here

Ensure the following commands execute successfully:

docker ps
docker-compose version
docker-machine ls

Development tooling

For development you need the following in addtion to the runtime tooling:

• Java 8 JDK (OpenJDK, Oracle Java SE JDK, on MacOS use AdoptOpenJDK)
• GIT
• NodeJS (>= 10.13.0, on MacOS you can use Homebrew and brew install node@10)
• yarn npm install --global yarn (>=1.12.1)

Ensure the following commands execute successfully:

java -version
git --version
node -v
yarn -v

Ensure that you have the JAVA_HOME environment variable set to the path of JDK.

See also

• Installing and using Docker
• Next 'Get Started' step: Build the code and run the manager
• Get Started