installationguide.md

Installation guide

Installing necessary software

• Git

  • Git can be downloaded from here.
  • Git installation guide.

• Docker

  • Docker Desktop for Windows and MacOS users can be downloaded from here.
    • Docker installation for Windows guide.
    • Docker installation for MacOS guide.
  • Docker installation for Linux users guide can be found here.
    • Please go to the Server section and select your Linux distribution.

• Docker-compose

  • Windows and MacOS users already have Docker-compose if they installed Docker Desktop. If you decided to do otherwise this guide should help.
  • Docker-compose installation for Linux users guide.

• Web browser for WEB interface or API tool / REST client for module API

  • Browsers
    • Google Chrome
    • Microsoft Edge
    • Opera
    • Brave
  • REST clients
    • Postman
    • Insomnia
    • Paw
    • soapUI

Getting required project files from the repository

• Create directory where project files will be downloaded or skip to Clone the repository step.
• Open terminal -
  • Linux users: CTRL + SHIFT + T
  • Windows users: Windows key + X and then press A key (For administrator access).
• Navigate to your created folder.
• Clone the repository:
  git clone https://github.com/Factobotics/FlexHex-Rose-AP
• Enter credentials if necessary.
• Project files should be downloaded in FlexHex-Rose-AP folder.

This is the end of the installation part for the module, for further steps, please nagivate to Getting started.