Skip to content

Latest commit

 

History

History
122 lines (72 loc) · 6.86 KB

vi-prerequisites.md

File metadata and controls

122 lines (72 loc) · 6.86 KB
Raw

Software Prerequisites - Environment Setup (Step 2)

Estimated Time: 1.5h

Objectives

  • Setup your development environment

Preparation

  • Stay Organized: We recommend creating a dedicated directory on your desktop or user folder for your work at OLE, such as ~/Projects/ole/ or ~/Documents/ole/. This keeps all your OLE-related repositories in one place for better organization and efficiency.
  • RAM: Ensure your machine has at least 8GB of RAM; 16GB is recommended for optimal performance.
  • Storage Space: Ensure your machine have at least a few GBs of free space on your computer before proceeding with the following steps.
  • Package Manager: We recommend you to get Chocolatey for Windows and Homebrew for macOS.

Dependencies Overview

The required dependencies to run the production version of the planet are:

  • Git
  • Docker

Git

Git is an open source version control system that we use for communication and management for our software.

Try git in your terminal app to see if Git is already installed, if not:

  • Debian/Ubuntu: apt-get update && apt-get install git
  • macOS: brew install git
  • Windows: choco install git.install
    • This will install Git Bash, which you can find in your Windows Start menu.
    • From now on, use Git Bash to run commands whenever appropriate.

For detailed instructions or alternative installation method, please go to Git - Downloads and select your operating system.

Docker

Docker is a platform for developers and sysadmins to develop, deploy, and run applications with containers. The use of containers to deploy applications is called containerization. Containers are not new, but their use for easily deploying applications is.

Install Docker Desktop – macOS

The easiest way to install Docker on macOS is by downloading Docker Desktop: brew install --cask docker

For alternative installation method, please visit Docker Desktop.

After installation, launch the Docker Desktop app.

Install Docker Engine – Linux

Go to Install Docker Engine | Docker Docs and select your Operating System under Platform column, follow the "Prerequisites" section, then follow "Installation methods - Install using the xxx repository".

Install Docker Desktop – Windows

Windows Subsystem for Linux (WSL)

We will need Windows Subsystem for Linux (WSL) version 2 to run Docker Desktop.

When you install WSL 2, You must be running Windows 10...

  • For x64 systems: Version 1903 or later, with Build 18362.1049 or later.
  • For ARM64 systems: Version 2004 or later, with Build 19041 or later.

or Windows 11.

If you're using an earlier version, please consider installing a Linux distro like Debian or Ubuntu to dual boot with Windows on your machine instead.

We prefer Debian instead of the default Ubuntu distribution. To install Debian using WSL, open PowerShell or Windows Command Prompt in administrator mode by right-clicking and selecting "Run as administrator", enter wsl --install -d Debian, then restart your machine.

Next, visit "How to install Linux on Windows with WSL" and follow the instructions in the following sections:

Docker Desktop

The easiest way to install Docker on Windows is by downloading Docker Desktop: choco install docker-desktop

For alternative installation method, please visit Docker Desktop.

After installation, launch the Docker Desktop app.

If the app flags an issue with virtualization, you may not have virtualization enabled. Refer to Common topics | Docker Docs to resolve the issue. If you are still running into issues after reading through the troubleshooting topics, please don't hesitate to reach out to us on the #vi-software Discord channel for help.

→ Next: Step 3.1 - Docker Tutorial

Return to First Steps