Skip to content

Local Development Setup

This document outlines the required tools and step-by-step instructions for configuring a local development environment compatible with the Hadox ecosystem.

Required Tools

Make sure the following tools are installed:

  • Windows Subsystem for Linux (WSL 2)
  • Ubuntu 22.04 LTS (or similar)
  • Docker Desktop (with WSL 2 integration enabled)
  • Visual Studio Code
  • Remote - WSL
  • Docker
  • GitLens
  • Git with SSH support

Setup Instructions

  1. Enable WSL 2 on Windows
    Follow Microsoft’s guide to install and configure WSL 2.

  2. Install Ubuntu
    From the Microsoft Store, install the Ubuntu 22.04 LTS distribution.

  3. Install Docker Desktop
    Enable WSL 2 backend during installation. Confirm Docker runs from inside your Ubuntu shell.

  4. Configure Git
    Generate SSH keys and connect to Gitea:

bash ssh-keygen -t ed25519 -C "you@example.com" eval "$(ssh-agent -s)" ssh-add ~/.ssh/id_ed25519

Then copy the contents of ~/.ssh/id_ed25519.pub and add it to your Gitea profile.

  1. Clone the repository
    Example:

bash git clone ssh://git@git.hadox.org:2222/hadoxmin/madlabs.git

  1. Open the project in VS Code
    Run code . from within the project directory in your WSL terminal.

  2. Start Docker containers
    If the repo uses docker-compose, you can start services with:

bash docker compose up -d --build

  1. Access services
    Projects are typically available at:
  2. http://localhost:8001 → Madlabs
  3. http://localhost:8010 → Polisplexity
  4. http://localhost:8005 → Developer Docs