​
Get your Weam AI application running locally with Docker and start building.

​
Mac/Linux Setup

​
Step 1: Set up your environment

​
Step 2: Access the application

​
Step 3: System requirements

​
Docker + WSL2 Setup on Windows

Follow this guide to install Docker, set up WSL2 with Ubuntu, and run your development environment smoothly from within Windows.

​
✅ Key Reminders

  • Always save .sh files with LF line endings
  • Use Ubuntu (WSL2) terminal
  • Ensure Docker Desktop is running before using Compose

​
Skipped Step: Python Base Image Build (pybase_docker)

This section outlines why the pybase_docker build step is intentionally skipped in the Docker workflow and when to re-enable it.

​
Overview

In the main build script, the following section is commented out: 
# echo "Step 1/5: Building base image (pybase_docker)..."
# $COMPOSE_CMD build pybase_docker --no-cache || { echo "❌ Failed to build pybase_docker"; exit 1; }
# echo "✅ pybase_docker image built successfully."
These lines are intentionally skipped to improve build efficiency and avoid unnecessary steps when working on the frontend or making non-Python-related changes.

​
Why Is It Skipped?

ReasonDescription
Not Required for FrontendThe pybase_docker image is only used by backend services. Frontend apps like weamai-app (Next.js) don’t rely on it.
Time EfficiencyBuilding Python images, especially with heavy dependencies, is time-consuming. Skipping it avoids delays.
No Dependency OverlapFrontend builds and backend builds are fully isolated. Skipping the Python base does not affect frontend builds.

​
When to Re-enable This Step

You should uncomment and run the pybase_docker build lines if any of the following conditions apply:
ConditionDescription
requirements.txt UpdatedIf you modified dependencies, Docker needs to rebuild with the new packages.
Clean Rebuild RequiredIf you’re doing a fresh or forceful rebuild (e.g., after removing Docker volumes/images), this step is essential.
Python Dependency IssuesIf backend services fail due to missing or outdated Python packages, a rebuild might resolve the issue.
To enable this step, simply uncomment the following lines in the script: 
echo "Step 1/5: Building base image (pybase_docker)..."
$COMPOSE_CMD build pybase_docker --no-cache || { echo "❌ Failed to build pybase_docker"; exit 1; }
echo "✅ pybase_docker image built successfully."

​
Next steps

Explore the codebase

Dive into the project structure and start making changes.

Contribute or extend

Add new features, fix bugs, or extend the Docker setup.
Need help? Check the project README or reach out via the GitHub issues tab.