Services

This guide will help you get any of the AcceleratXR services up and running locally.

Workstation Setup

Before any of the services will run you will need to install a few developer tools.

Docker & Kubernetes

All services can be run locally without the use of a container system like Docker. However Docker & Kubernetes is recommended as it is how all AcceleratXR services are built and deployed in a production cluster environment. All services also come with docker-compose files to make it easier to run locally.

Windows (Chocolatey)

On Windows it is recommended that you install Docker for Windows. You can install Docker for Windows easily using Chocolatey.

cinst docker-for-windows

Once installed and started make sure to enable the Kubernetes engine.

Mac OS X (Brew)

On Mac OS X it is recommended that you install Docker for Mac. Once installed and started make sure to enable the Kubernetes engine.

Ubuntu / Debian

For Ubuntu / Debian you will need to install Docker and Kubernetes separately. This can be easily accomplished using apt.

apt-get update && apt-get install docker docker-compose minikube

NodeJS

The next thing you will need is NodeJS. All AcceleratXR services are developed with NodeJS and written in the TypeScript language.

Windows (Chocolatey)

You can easily install NodeJS via Powershell using Chocolatey.

cinst nodejs

Mac OS X (Brew)

You can easily install NodeJS via Terminal using Brew.

brew install nodejs

Ubuntu / Debian

You can easily install NodejS using Apt.

apt-get update && apt-get install nodejs

Visual Studio Code

While you can use any IDE you choose, Visual Studio Code is the recommended IDE of choice by the AcceleratXR team and all services already have pre-configured project workspaces ready to go out of the box.

Some recommended plug-ins that you should consider installing are:

Building & Running

Once you’ve got all the above developer tools installed it’s time to try starting your first AcceleratXR service. After you’ve pulled down the project code from the GitLab repository you’re ready to begin.

Open up your favorite shell or terminal and run the following commands.

docker-compose build && docker-compose up