Skip to content

prerequisites.md

Latest commit

 

History

History
221 lines (149 loc) · 4.39 KB

prerequisites.md

File metadata and controls

221 lines (149 loc) · 4.39 KB
Raw

Prerequisites

Docs > Getting Started > Prerequisites

Before you can run The Atlas locally, make sure you have the following installed:

Required

Python 3.12+

The API runs on Python 3.12+.

macOS (Homebrew):

brew install python@3.12
python3.12 --version  # Verify

Linux (Ubuntu/Debian):

sudo apt-get update
sudo apt-get install python3.12 python3.12-venv python3.12-dev
python3.12 --version  # Verify

macOS/Linux (pyenv):

brew install pyenv          # Or follow pyenv install guide
pyenv install 3.12.0
pyenv local 3.12.0
python --version  # Verify

Windows: Download from python.org and run installer, or use Windows Package Manager:

winget install Python.Python.3.12
python --version  # Verify

Node.js 24.18+ in the 24.x line

The app runs on Node.js 24.18+ in the Node 24 release line.

macOS (Homebrew):

brew install node@24
node --version  # Verify (should be v24.18+ and below v25)

Linux (Ubuntu/Debian):

curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
sudo apt-get install -y nodejs
node --version  # Verify

macOS/Linux (nvm - Node Version Manager):

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install 24.18.0
nvm use 24.18.0
node --version  # Verify

Windows: Download from nodejs.org or use Windows Package Manager:

winget install OpenJS.NodeJS
node --version  # Verify

Corepack and pnpm

Atlas uses the Corepack bundled with Node.js to activate pnpm 11.10.0.

corepack enable
corepack prepare pnpm@11.10.0 --activate
pnpm --version  # Verify

Make

Build automation tool. Used to run development commands.

macOS (Homebrew):

brew install make
make --version  # Verify

Linux (Ubuntu/Debian):

sudo apt-get install make
make --version  # Verify

Windows: Install via MinGW or GNU Make for Windows, or use Windows Subsystem for Linux (WSL).

Git

Version control. You likely have this already.

macOS:

brew install git
git --version  # Verify

Linux:

sudo apt-get install git
git --version  # Verify

Windows: Download from git-scm.com

Optional (for Docker development)

Docker & Docker Compose

If you prefer running services in containers instead of locally.

macOS: Install Docker Desktop for Mac

Linux:

sudo apt-get install docker.io docker-compose
sudo usermod -aG docker $USER  # Add user to docker group

Windows: Install Docker Desktop for Windows

Verify both are installed:

docker --version
docker compose --version

Verification Checklist

Run these commands to verify everything is installed:

# Python
python3 --version          # Should be 3.12+

# Node
node --version             # Should be v24.18+ and below v25
pnpm --version             # Should be 11.10+

# Make
make --version             # Should show version

# Git
git --version              # Should show version

# Optional: Docker
docker --version           # If using Docker
docker compose --version   # If using Docker

If all commands return versions without errors, you're ready for Quick Start.

Troubleshooting

"python3 command not found"

Make sure Python 3.12+ is installed and in your PATH. On macOS with Homebrew, you may need to use python3.12 instead of python3.

"node command not found"

Make sure Node.js 24.18+ in the Node 24 release line is installed. If you installed with nvm, run nvm use 24.18.0 first.

"pnpm command not found"

Make sure Node.js 24.18+ in the Node 24 release line is installed, then run corepack enable and corepack prepare pnpm@11.10.0 --activate.

"make command not found"

Install Make (see instructions above). On Windows, consider using WSL or MinGW.

Permission denied errors on Linux

You may need to use sudo for Docker commands, or add your user to the docker group:

sudo usermod -aG docker $USER
newgrp docker  # Apply group change without logout

Next: Quick Start