Prerequisites

Before you can run Jubiloop locally, make sure you have the following tools installed on your system.

Required Software

Node.js

• Version: v24.x or later
• Why: Jubiloop is built with modern JavaScript/TypeScript and requires Node.js 24+ features
• Installation: Download from nodejs.org or use a version manager like nvm

npm

• Version: v10.x or later recommended
• Why: Package manager for installing dependencies across the monorepo
• Installation: Comes bundled with Node.js

Docker Desktop

• Why: The recommended Docker Stack runs all services (PostgreSQL, Redis, apps) in Docker — you don't need Node.js, PostgreSQL, or Redis installed globally
• Installation: Download from docker.com

macOS — enable VirtioFS for fast hot reload:

After installing Docker Desktop, go to Settings → General and enable "Use Virtualization framework" (VirtioFS). Click Apply & Restart.

macOS performance

Without VirtioFS, file-watching inside Docker containers is noticeably slow. Hot reload will work but feel laggy. This setting is easy to miss and worth checking first.

Linux:

Use Docker Engine + Docker Compose plugin. No extra settings required.

Recommended Editor

VS Code (or your preferred editor)

• Why: Code editing with excellent TypeScript support
• Installation: Download from code.visualstudio.com

Verifying Installation

After installing the prerequisites, verify everything is set up correctly:

# Check Node.js version
node --version
# Should output: v24.x.x or higher

# Check npm version
npm --version
# Should output: 10.x.x or higher

# Check Docker is running
docker --version
# Should output Docker version information

# Check Docker Compose
docker compose version
# Should output Docker Compose version information

System Requirements

• Operating System: macOS, Linux, or Windows (with WSL2)
• RAM: Minimum 8GB recommended (for running all services)
• Disk Space: At least 2GB free space

---

Next: Installation