Installation

Prerequisites

Before you begin, make sure the following tools are installed on your machine:

• Docker — version 24 or later recommended
• Docker Compose — v2 (included with Docker Desktop; available as docker compose on Linux)

No other local dependencies are required. The entire stack — backend, frontend, database, and background workers — runs inside containers.

Step-by-Step Setup

1. Clone the Repository

git clone https://github.com/your-org/lineo-pm.git
cd lineo-pm

2. Start the Development Stack

docker compose -f docker-compose.dev.yml up -d --build

This command will:

• Build Docker images for the backend and frontend (first run takes a few minutes)
• Start the FastAPI backend
• Start the React/Vite frontend dev server
• Start a PostgreSQL database
• Start the Celery worker for background simulation jobs
• Apply database migrations automatically

3. Verify the Stack is Running

docker compose -f docker-compose.dev.yml ps

All services should show running or Up status.

What’s Available After Startup

About the Celery Worker

Lineo-PM uses Celery for running Monte Carlo simulations asynchronously. When you trigger a simulation from the UI, the request is queued and processed in the background by the Celery worker container. The result is stored in the database and displayed in the frontend once the job completes.

The Celery worker and its broker (Redis) are started automatically as part of the docker compose setup — no additional configuration is required.

Stopping the Stack

docker compose -f docker-compose.dev.yml down

To also remove the database volume (full reset):

docker compose -f docker-compose.dev.yml down -v

Next Steps

→ Quick Start Guide — create your first project and explore the core features