Skip to content

Prerequisites

To get started with Change Maker, ensure you have the following prerequisites:

General Requirements

  • Operating System: Linux or MacOS
  • Internet Connection: Required for initial setup to download the latest versions of the software
  • Memory: Minimum 2GB RAM. 4GB RAM is recommended
  • Disk Space: Around 10GB of free disk space; more or less depending on size of website build (installation size is ~1GB)

Necessary: Docker and Docker Compose

Change Maker uses Docker and Docker Compose for containerization. Follow the instructions below to install Docker and Docker Compose on your platform.

Docker

Mac

  1. Install Docker Desktop for Mac:
    • Download and install Docker Desktop from Docker's official site
    • Docker Desktop supports both Intel and Apple Silicon Macs

Linux

  1. Install Docker:

  2. Install Docker Compose:

  3. Post-installation steps: 

    # Add your user to the docker group
sudo usermod -aG docker $USER

# Start and enable Docker service
sudo systemctl start docker
sudo systemctl enable docker

Obsidian is a powerful markdown editor that can be used to edit the documentation files. It is not required, but it is recommended for a better editing experience.

Obsidian

More info on configurint Obsidian can be found here.

Power User: Visual Studio Code

Visual Studio Code is a powerful code editor that can be used to edit the source code. Visual Code Studio, if properly configured, is the fastest method to generate a site. Built in AI allows your to edit your entire codebase using plain language prompts. It is not required, but it is recommended for a better coding experience.

Visual Studio Code