Requirements

In This Document

• In This Document
• System Requirements
• Checking Your Installed Versions
• Next Steps

Before setting up the project, ensure your system meets the following requirements:

System Requirements

Prerequisites

The following software must be installed on your system before proceeding with the Planet project setup:

All Systems

Required Software Versions

Node.js: >=18.0.0
npm: >=8.0.0
php: >=8.1
composer: >=2.1.0
docker: >=20.10.0

Linux

For Linux users, you can install these dependencies using your distribution's package manager:

Ubuntu/Debian

# Update package lists
sudo apt update

# Install Node.js and npm
sudo apt install nodejs npm

# Install PHP
sudo apt install php8.1 php8.1-cli php8.1-common

# Install Composer
curl -sS https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composer

macOS

For macOS users, we recommend using Homebrew:

macOS with Homebrew

# Install Homebrew if not already installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install Node.js and npm
brew install node

# Install PHP
brew install php@8.1

# Install Composer
brew install composer

Windows

For Windows users, we recommend using WSL2 (Windows Subsystem for Linux) for the best development experience.

Alternatively, you can install the requirements directly:

1. Download and install Node.js from nodejs.org
2. Download and install PHP from windows.php.net
3. Download and install Composer from getcomposer.org

These requirements are essential for the proper functioning of the project. Make sure you have the correct versions installed on your system before proceeding with the installation.

Checking Your Installed Versions

You can verify your installed versions using the following commands:

Node.js & npm

Check Node.js and npm versions

node -v
npm -v

Expected output:

v18.16.0  # or higher
8.19.3    # or higher

PHP & Composer

Check PHP and Composer versions

php -v
composer -v

Expected output:

PHP 8.1.10 (cli) # or higher
Composer version 2.5.8 # or higher

Docker

Check Docker versions

docker -v
docker compose version

Expected output:

Docker version 20.10.21 # or higher
Docker Compose version v2.13.0 # or higher

Version Mismatch

If any of these components are missing or outdated, please install or update them before continuing with the project setup. Using incompatible versions may lead to unexpected issues during development.

Next Steps

Once you've confirmed that your system meets all the requirements, you can proceed to:

1. Docker Setup - Install and configure Docker
2. Project Setup - Set up the Planet project