datadrivenconstruction · Trending

datadrivenconstruction/OpenConstructionERP

Open-source construction ERP - BOQ, PDF/CAD/BIM takeoff, AI cost matching, 293 guided cases. 120,000+ priced positions, 44 languages, 190+ modules, cost data for 40+ markets. AGPL-3.0. pip install openconstructionerp

View on GitHub Website / Demo Back to listing

1.3kstars 399forks 78contributors TypeScript

README.md

View on GitHub

# OpenConstructionERP

### A leading open-source workspace for construction project management

Professional BOQ, CAD and BIM takeoff, 4D scheduling, 5D cost model, and tendering - all in one self-hosted platform.

**Like WordPress for construction companies** - pick modules from the marketplace, drop in your own, or replace ours with custom-built ones. Same plug-and-play model, but for BOQ, scheduling, cost control, BIM, and tendering.

[▶ Watch the 12-min walkthrough](https://www.youtube.com/watch?v=X06cIaroAeI) · [Demo](https://openconstructionerp.com) · [Documentation](https://openconstructionerp.com/docs) · [Build on it](DEVELOPING.md) · [Community chat (Telegram)](https://t.me/datadrivenconstruction) · [Report Bug](https://github.com/datadrivenconstruction/OpenConstructionERP/issues)

[![License](https://img.shields.io/badge/license-AGPL--3.0-blue)](LICENSE) [![Version](https://img.shields.io/github/v/release/datadrivenconstruction/OpenConstructionERP?label=version&color=green)](https://github.com/datadrivenconstruction/OpenConstructionERP/releases/latest) [![Release downloads](https://img.shields.io/github/downloads/datadrivenconstruction/OpenConstructionERP/total?label=downloads&color=brightgreen)](https://github.com/datadrivenconstruction/OpenConstructionERP/releases) [![PyPI](https://img.shields.io/pypi/v/openconstructionerp?color=informational&label=pypi)](https://pypi.org/project/openconstructionerp/) [![Downloads (pepy · per month)](https://static.pepy.tech/personalized-badge/openconstructionerp?period=month&units=international_system&left_color=grey&right_color=blue&left_text=downloads%20(pepy%20%C2%B7%20per%20month))](https://pepy.tech/project/openconstructionerp) [![Stars](https://img.shields.io/github/stars/datadrivenconstruction/OpenConstructionERP?style=flat&logo=github)](https://github.com/datadrivenconstruction/OpenConstructionERP/stargazers) [![Last commit](https://img.shields.io/github/last-commit/datadrivenconstruction/OpenConstructionERP?color=informational)](https://github.com/datadrivenconstruction/OpenConstructionERP/commits/main)
![Languages](https://img.shields.io/badge/languages-44-orange) ![Cost Items](https://img.shields.io/badge/cost_items-120%2C000%2B-red) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/datadrivenconstruction/OpenConstructionERP/badge)](https://securityscorecards.dev/viewer/?uri=github.com/datadrivenconstruction/OpenConstructionERP) [![CodeQL](https://github.com/datadrivenconstruction/OpenConstructionERP/actions/workflows/codeql.yml/badge.svg)](https://github.com/datadrivenconstruction/OpenConstructionERP/actions/workflows/codeql.yml) [![Signed releases](https://img.shields.io/badge/releases-Sigstore_signed-8250df)](SECURITY.md)

<video src="https://github.com/user-attachments/assets/20b9b585-93ac-4829-a3dc-0ede9ca9e2fc" controls width="800" playsinline>
 <a href="https://github.com/datadrivenconstruction/OpenConstructionERP/releases/download/v2.0.0/oce_full_demo.mp4">▶ 1-minute teaser</a>
</video>

<picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/device-camera-video-dark.svg"><img src="docs/readme-icons/device-camera-video-light.svg" width="14" align="center" alt=""></picture> 1-minute teaser above · for the full 12-minute walkthrough → <a href="https://www.youtube.com/watch?v=X06cIaroAeI">watch on YouTube</a> · onboarding → BOQ → BIM → DWG → PDF → AI → dashboard

### Download the free desktop app

No Python, no Docker, nothing to set up. Pick your system and run it.

Not sure which file? <a href="https://openconstructionerp.com/download">openconstructionerp.com/download</a> picks the right one for you automatically. Prefer the terminal? <code>pip install openconstructionerp</code> or Docker, see <a href="#quick-start">Quick Start</a> below.

<table>
<tr>
<td align="center" width="16.66%">120K+ cost&nbsp;items</td>
<td align="center" width="16.66%">44 languages</td>
<td align="center" width="16.66%">47 countries</td>
<td align="center" width="16.66%">6 CAD&nbsp;formats</td>
<td align="center" width="16.66%">190+ modules</td>
<td align="center" width="16.66%">293 guided&nbsp;cases</td>
</tr>
</table>

</div>

---

<details open>
<summary><h2>Table of Contents</h2></summary>

<picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/rocket-dark.svg"><img src="docs/readme-icons/rocket-light.svg" width="14" align="center" alt=""></picture> **Get Started**
- [Video guides](#video-guides)
- [Why OpenConstructionERP?](#why-openconstructionerp)
- [A Look Inside](#a-look-inside)
- [Quick Start](#quick-start)
- [Demo Accounts](#demo-accounts)

</td>
<td valign="top">

<picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/credit-card-dark.svg"><img src="docs/readme-icons/credit-card-light.svg" width="14" align="center" alt=""></picture> **Estimating & Costs**
- [Bill of Quantities](#-bill-of-quantities-boq-management)
- [Cost Databases & Catalog](#-cost-databases--resource-catalog)
- [CAD/BIM Takeoff & AI](#-cadbim-takeoff--ai-estimation)

</td>
<td valign="top">

<picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/shield-check-dark.svg"><img src="docs/readme-icons/shield-check-light.svg" width="14" align="center" alt=""></picture> **Quality & Setup**
- [Guided Onboarding](#-guided-onboarding)
- [All 190+ Modules](MODULES.md)

</td>
</tr>
<tr>
<td valign="top">

<picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/code-dark.svg"><img src="docs/readme-icons/code-light.svg" width="14" align="center" alt=""></picture> **Technical**
- [Tech Stack](#tech-stack)
- [Architecture](#architecture)
- [Security](#security)

</td>
<td valign="top">

<picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/people-dark.svg"><img src="docs/readme-icons/people-light.svg" width="14" align="center" alt=""></picture> **Community**
- [Contributors](#contributors)
- [Support the Project](#support-the-project)
- [AI Disclaimer](#ai-disclaimer)
- [Trademarks](#trademarks)

</td>
<td valign="top">

<picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/law-dark.svg"><img src="docs/readme-icons/law-light.svg" width="14" align="center" alt=""></picture> **Legal & Privacy**
- [License](#license)
- [Privacy and Terms](#privacy-and-terms)

</td>
</tr>
</table>

</details>

---

> **Ready to try it?** See the **[Getting Started guide](docs/getting-started.md)** for three ways to install (desktop app, pip, Docker) with prerequisites and step-by-step instructions, or jump straight to the **[Quick Start](#quick-start)** section below.

---

## Video guides

**108 videos in 16 playlists**, each following a real project in one country, in its language, with its own contracts, standards and payment rules. [Browse the channel](https://www.youtube.com/channel/UCQ3IWLMLnBFwNeG5VBxXQ5Q/videos) or take a [free or paid course](https://openconstructionacademy.com/courses/) at the OpenConstruction Academy.

<table>
<tr>
<td width="25%" valign="top"><a href="https://www.youtube.com/watch?v=WjDK-uk9b1w"><img src="https://i.ytimg.com/vi/WjDK-uk9b1w/hqdefault.jpg" alt="Install and set up your first project" width="100%"></a> Install and set up your first project · 4:41</td>
<td width="25%" valign="top"><a href="https://www.youtube.com/watch?v=X06cIaroAeI"><img src="https://i.ytimg.com/vi/X06cIaroAeI/hqdefault.jpg" alt="Full product walkthrough" width="100%"></a> Full product walkthrough · 12:00</td>
<td width="25%" valign="top"><a href="https://www.youtube.com/watch?v=zGgfX19b3gc"><img src="https://i.ytimg.com/vi/zGgfX19b3gc/hqdefault.jpg" alt="Build an estimate step by step" width="100%"></a> Build an estimate step by step · 4:48</td>
<td width="25%" valign="top"><a href="https://www.youtube.com/watch?v=FRI5_7CsZT0"><img src="https://i.ytimg.com/vi/FRI5_7CsZT0/hqdefault.jpg" alt="Overhead, profit and contingency" width="100%"></a> Overhead, profit and contingency · 3:54</td>
</tr>
</table>

<details>
<summary>All playlists by country and language</summary>

| | |
|---|---|
| 🇺🇸 [Builder's Playbook USA](https://www.youtube.com/playlist?list=PLWgzwe9nHkSc) (10) | 🇬🇧 [Builder's Playbook UK](https://www.youtube.com/playlist?list=PLTRtkYLR23qM) (6) |
| 🇨🇦 [Builder's Playbook Canada](https://www.youtube.com/playlist?list=PLPZV4i5ViBm8) (6) | ⚜️ [Builder's Playbook Québec](https://www.youtube.com/playlist?list=PLey59QidNON0) (5) |
| 🇩🇪 [Auf Deutsch, Projekt Landshut](https://www.youtube.com/playlist?list=PLKN9p-CuMMkE) (12) | 🇩🇪 [Kosten nach DIN 276](https://www.youtube.com/playlist?list=PLEvGjPeBbuxQ) (8) |
| 🇫🇷 [En français, gérer un chantier](https://www.youtube.com/playlist?list=PLEhAODe5YAXM) (4) | 🇪🇸 [Builder's Playbook España](https://www.youtube.com/playlist?list=PLHgtnDPr3Rjg) (8) |
| 🇮🇹 [Builder's Playbook Italia](https://www.youtube.com/playlist?list=PLObqqyP8chDs) (7) | 🇧🇬 [Builder's Playbook България](https://www.youtube.com/playlist?list=PLfSvz7emI6lQ) (9) |
| 🇭🇷 [Builder's Playbook Hrvatska](https://www.youtube.com/playlist?list=PLP4TpwP1yVyI) (5) | 🇵🇱 [Budowa domu: kosztorys i rozliczenie](https://www.youtube.com/playlist?list=PLVLOe3pv2_oo) (5) |
| 🇹🇷 [Okul ek binası: maliyetten kesin hesaba](https://www.youtube.com/playlist?list=PLL2jqtV6A934) (5) | 🇸🇦 [عظم فيلا في الرياض](https://www.youtube.com/playlist?list=PLO8UfCu9nokM) (5) |
| 🇧🇷 [Builder's Playbook Brasil](https://www.youtube.com/playlist?list=PLLe-gfSauXTY) (5) | 🇨🇳 [Builder's Playbook 中国](https://www.youtube.com/playlist?list=PLOCZ6EOWyC_A) (8) |

Also: [The uberization of construction (ETH Zürich)](https://www.youtube.com/watch?v=R_PQQHXY-rQ), a 14-minute talk on where construction software is heading.

</details>

---

## Why OpenConstructionERP?

Construction cost estimation software is expensive, closed-source, and locked to specific regions. OpenConstructionERP changes that.

| What you get | How it works |
|-------------|-------------|
| **Free forever** | AGPL-3.0 license. No subscriptions, no per-seat fees, no vendor lock-in. |
| **Your data, your server** | Self-hosted. Everything runs on your machine - nothing leaves your network. |
| **44 languages** | Full UI translation: English, German, French, Spanish, Portuguese, Russian, Chinese, Arabic, Hindi, Japanese, Korean, and 33 more. |
| **30+ regional standards** | DIN 276, NRM 1/2, CSI MasterFormat, GAEB, ГЭСН, DPGF, GB/T 50500, CPWD, ÖNORM, Birim Fiyat, Sekisan, SINAPI, and more. |
| **AI-powered** | Connect any LLM provider (Anthropic, OpenAI, Gemini, Mistral, Groq, DeepSeek) for smart estimation. |
| **120,000+ cost items** | Nine cost bases covering 40+ markets - global CWICR plus eight national bases (China, Turkey, Brazil, Spain, Italy, Greece, Vietnam, Indonesia). |

### The whole platform in your language

The entire UI ships in **44 languages**, including full right-to-left support for Arabic, Urdu, Persian and Hebrew. Switch language from any screen and every label, message and report follows.

🇬🇧 English &nbsp;·&nbsp; 🇩🇪 Deutsch &nbsp;·&nbsp; 🇫🇷 Français &nbsp;·&nbsp; 🇪🇸 Español &nbsp;·&nbsp; 🇲🇽 Español (MX) &nbsp;·&nbsp; 🇨🇱 Español (CL) &nbsp;·&nbsp; 🇨🇴 Español (CO) &nbsp;·&nbsp; 🇵🇹 Português &nbsp;·&nbsp; 🇧🇷 Português (BR) &nbsp;·&nbsp; 🇷🇺 Русский &nbsp;·&nbsp; 🇨🇳 简体中文 &nbsp;·&nbsp; 🇸🇦 العربية &nbsp;·&nbsp; 🇮🇳 हिन्दी &nbsp;·&nbsp; 🇹🇷 Türkçe &nbsp;·&nbsp; 🇮🇹 Italiano &nbsp;·&nbsp; 🇳🇱 Nederlands &nbsp;·&nbsp; 🇵🇱 Polski &nbsp;·&nbsp; 🇨🇿 Čeština &nbsp;·&nbsp; 🇯🇵 日本語 &nbsp;·&nbsp; 🇰🇷 한국어 &nbsp;·&nbsp; 🇸🇪 Svenska &nbsp;·&nbsp; 🇳🇴 Norsk &nbsp;·&nbsp; 🇩🇰 Dansk &nbsp;·&nbsp; 🇫🇮 Suomi &nbsp;·&nbsp; 🇧🇬 Български &nbsp;·&nbsp; 🇭🇷 Hrvatski &nbsp;·&nbsp; 🇭🇺 Magyar &nbsp;·&nbsp; 🇮🇩 Bahasa Indonesia &nbsp;·&nbsp; 🇷🇴 Română &nbsp;·&nbsp; 🇹🇭 ไทย &nbsp;·&nbsp; 🇻🇳 Tiếng Việt &nbsp;·&nbsp; 🇺🇦 Українська &nbsp;·&nbsp; 🇬🇷 Ελληνικά &nbsp;·&nbsp; 🇰🇬 Кыргызча &nbsp;·&nbsp; 🇰🇿 Қазақша &nbsp;·&nbsp; 🇧🇩 বাংলা &nbsp;·&nbsp; 🇪🇪 Eesti &nbsp;·&nbsp; 🇵🇭 Filipino &nbsp;·&nbsp; 🇵🇰 اردو &nbsp;·&nbsp; 🇮🇷 فارسی &nbsp;·&nbsp; 🇮🇱 עברית &nbsp;·&nbsp; 🇺🇿 Oʻzbekcha &nbsp;·&nbsp; 🇲🇳 Монгол

### How It Compares

<table width="100%">
<colgroup>
<col width="26%" />
<col width="20%" />
<col width="14%" />
<col width="13%" />
<col width="14%" />
<col width="13%" />
</colgroup>
<thead>
<tr>
<th align="left">Capability</th>
<th align="center">OpenConstructionERP</th>
<th align="center">Enterprise BIM</th>
<th align="center">CAD Takeoff</th>
<th align="center">Legacy Estimating</th>
<th align="center">PDF Markup</th>
</tr>
</thead>
<tbody>
<tr><td>License</td><td align="center">AGPL-3.0 (free)</td><td align="center">Proprietary</td><td align="center">Proprietary</td><td align="center">Proprietary</td><td align="center">Proprietary</td></tr>
<tr><td>Self-hosted / offline</td><td align="center">&#10004;</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#9888; partial</td><td align="center">&#10006;</td></tr>
<tr><td>Price</td><td align="center">Free forever</td><td align="center">~&#8364;500/mo</td><td align="center">~&#8364;300/mo</td><td align="center">~&#8364;200/mo</td><td align="center">~&#8364;30/mo</td></tr>
<tr><td>AI estimation</td><td align="center">&#10004; 20 LLM providers</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#10006;</td></tr>
<tr><td>UI languages</td><td align="center">44</td><td align="center">5</td><td align="center">3</td><td align="center">2</td><td align="center">8</td></tr>
<tr><td>Regional standards</td><td align="center">30+</td><td align="center">4</td><td align="center">3</td><td align="center">2</td><td align="center">-</td></tr>
<tr><td>BOQ editor</td><td align="center">&#10004;</td><td align="center">&#10004;</td><td align="center">&#10004;</td><td align="center">&#10004;</td><td align="center">&#10006;</td></tr>
<tr><td>CAD/BIM takeoff</td><td align="center">&#10004; RVT IFC DWG</td><td align="center">&#10004;</td><td align="center">&#10004;</td><td align="center">&#10006;</td><td align="center">PDF only</td></tr>
<tr><td>4D/5D planning</td><td align="center">&#10004;</td><td align="center">&#10004;</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#10006;</td></tr>
<tr><td>Cost database included</td><td align="center">&#10004; 120K+ rates</td><td align="center">&#10006; extra</td><td align="center">&#10006; extra</td><td align="center">&#10006; extra</td><td align="center">&#10006;</td></tr>
<tr><td>Resource catalog</td><td align="center">&#10004; 7K+ priced</td><td align="center">&#10006; extra</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#10006;</td></tr>
<tr><td>Validation engine</td><td align="center">&#10004; built-in rules</td><td align="center">&#9888; limited</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#10006;</td></tr>
<tr><td>REST API</td><td align="center">&#10004; full</td><td align="center">&#9888; limited</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#10006;</td></tr>
<tr><td>Real-time collab</td><td align="center">&#10004; soft locks</td><td align="center">&#10004;</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#10006;</td></tr>
<tr><td>Open data export</td><td align="center">&#10004; GAEB · XLSX · JSON</td><td align="center">&#9888; limited</td><td align="center">&#9888; limited</td><td align="center">&#9888; limited</td><td align="center">PDF only</td></tr>
<tr><td>IDS / COBie requirements</td><td align="center">&#10004; import + export</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#10006;</td></tr>
<tr><td>Property dev lifecycle</td><td align="center">&#10004; Lead → SPA → Handover</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#10006;</td></tr>
<tr><td>3D globe / geo-anchor</td><td align="center">&#10004; Cesium 3D Tiles</td><td align="center">&#9888; map only</td><td align="center">&#10006;</td><td align="center">&#10006;</td><td align="center">&#10006;</td></tr>
</tbody>
</table>

Comparison reflects typical category capabilities based on publicly available information. Pricing is approximate (per-seat, list price) and varies by vendor and region. OpenConstructionERP is an independent open-source project and is not affiliated with any commercial vendor in the categories above.

---

## A Look Inside

A quick tour of the main workspaces. Every screen is the real application running the 70-project demo spanning 30+ countries that ships with a fresh install.

<table>
<tr>
<td align="center" width="50%">
Portfolio Dashboard 
Every project on one live map, with multi-currency totals that are grouped by currency, never blended. 
<img src="docs/screenshots/gallery/portfolio-dashboard.jpg" alt="Portfolio dashboard with world map and KPIs" width="420" />
</td>
<td align="center" width="50%">
Projects 
Localized projects worldwide. Each card carries its site map, BIM / DWG / PDF badges and live value. 
<img src="docs/screenshots/gallery/projects.jpg" alt="Projects overview with localized project cards" width="420" />
</td>
</tr>
<tr>
<td align="center">
BOQ Editor 
Keyboard-first bill of quantities with sections, assemblies, a live quality score and grand total. 
<img src="docs/screenshots/gallery/boq-editor.jpg" alt="Bill of Quantities editor" width="420" />
</td>
<td align="center">
Cost Database 
120,000+ priced items across 9 cost bases, bilingual, searchable by code, unit or class. 
<img src="docs/screenshots/gallery/cost-database.jpg" alt="Regional cost databases" width="420" />
</td>
</tr>
<tr>
<td align="center">
3D BIM Viewer 
Federated models in the browser with a category and storey breakdown. Converted with DDC Converters 2.0. 
<img src="docs/screenshots/gallery/bim-3d-viewer.jpg" alt="3D BIM viewer with element summary" width="420" />
</td>
<td align="center">
Clash Detection 
Geometric coordination across federated models, with a clash matrix and BCF export. 
<img src="docs/screenshots/gallery/clash-detection.jpg" alt="Clash detection across federated models" width="420" />
</td>
</tr>
<tr>
<td align="center">
PDF Takeoff 
Drop a drawing, let AI extract the quantities, then push them straight into the BOQ. 
<img src="docs/screenshots/gallery/pdf-takeoff.jpg" alt="AI-assisted PDF takeoff" width="420" />
</td>
<td align="center">
AI Estimate 
Turn text, a photo, a PDF or a spreadsheet into a scoped BOQ in seconds, with confidence scores. 
<img src="docs/screenshots/gallery/ai-estimate.jpg" alt="AI quick estimate" width="420" />
</td>
</tr>
<tr>
<td align="center">
Validation 
Built-in DIN 276, NRM and MasterFormat rules score every BOQ with a traffic-light report. 
<img src="docs/screenshots/gallery/validation.jpg" alt="Validation report with traffic-light score" width="420" />
</td>
<td align="center">
Cross-Project Analytics 
Portfolio KPIs grouped by currency: budget, actuals and variance, project by project. 
<img src="docs/screenshots/gallery/analytics.jpg" alt="Cross-project analytics grouped by currency" width="420" />
</td>
</tr>
<tr>
<td align="center" colspan="2">
Finance &amp; Earned Value 
Budgets, invoices, payments and earned value tracked against the estimate. 
<img src="docs/screenshots/gallery/finance.jpg" alt="Finance and earned value management" width="420" />
</td>
</tr>
</table>

---

## Key Features

### <picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/graph-dark.svg"><img src="docs/readme-icons/graph-light.svg" width="14" align="center" alt=""></picture> Bill of Quantities (BOQ) Management

Build professional cost estimates with a powerful BOQ editor. The full lifecycle - from first sketch to final tender submission:

- **Hierarchical BOQ structure** - Sections, positions, sub-positions with drag-and-drop reordering
- **Inline editing** - Click any cell to edit. Tab between fields. Undo/redo with Ctrl+Z
- **Resources & assemblies** - Link labor, materials, equipment to each position. Build reusable cost recipes
- **Markups** - Overhead, profit, VAT, contingency - configure per project or use regional defaults
- **Automatic calculations** - Quantity × unit rate = total. Section subtotals. Grand total with markups
- **Validation** - Built-in rules check for missing quantities, zero prices, duplicate items, and compliance with DIN 276, NRM, MasterFormat
- **Export** - Download as Excel, CSV, PDF report, or GAEB XML (X83)

### <picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/database-dark.svg"><img src="docs/readme-icons/database-light.svg" width="14" align="center" alt=""></picture> Cost Databases & Resource Catalog

- **Cost bases** - 120,000+ cost items across 9 bases and 40+ markets: the global CWICR database covering all major construction trades, plus 8 national bases built on each country's own norm system (China, Turkey, Brazil, Spain, Italy, Greece, Vietnam, Indonesia)
- **Smart search** - Find items by description, code, or classification. AI-powered semantic search matches meaning, not just keywords ("concrete wall" finds "reinforced partition C30/37")
- **Resource catalog** - 7,000+ materials, equipment, labor rates, and operators. Build custom assemblies from catalog items
- **Regional pricing** - Automatic price adjustment based on project location. Compare rates across regions
- **Import your data** - Upload your own cost database from Excel, CSV, or connect via API

### <picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/tools-dark.svg"><img src="docs/readme-icons/tools-light.svg" width="14" align="center" alt=""></picture> CAD/BIM Takeoff & AI Estimation

Extract quantities from any source - drawings, models, text, or photos:

- **CAD/BIM takeoff** - Upload RVT, IFC or DWG files. DDC converters extract elements with volumes, areas, and lengths automatically
- **Interactive QTO** - Choose how to group extracted data: by Category, Type, Level, Family. Format-specific presets for RVT and IFC
- **Linked geometry preview** - Click the BIM link badge on any BOQ position to see a 3D preview of linked elements with interactive rotate/zoom/pan controls
- **BIM Quantity Picker** - Select quantities (area, volume, length) directly from linked BIM elements and apply them to BOQ positions. The source parameter name is shown next to the unit
- **DWG polyline measurement** - Click any polyline in the DWG viewer to instantly see area, perimeter, and individual segment lengths with on-canvas labels
- **PDF measurement** - Open construction drawings directly in the browser. Measure distances, areas, and count elements with calibrated scale
- **AI estimation** - Describe your project in plain text, upload a building photo, or paste a PDF - AI generates a complete BOQ with quantities and market rates
- **AI Cost Advisor** - Ask questions about pricing, materials, or estimation methodology. AI answers using your cost database as context
- **Cost matching** - After AI generates an estimate, match each item against your CWICR database to replace AI-guessed rates with real market prices

The platform also includes 3D globe visualization (Cesium), property development lifecycle, accommodation management, an AI assistant that prepares changes for a person to approve, BIM clash detection, 4D/5D scheduling, tendering and risk management, PDF markups, punch lists, daily diary with HSE tracking, and 30+ regional classification standards. See [MODULES.md](MODULES.md) for the full list of 190+ modules.

### <picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/rocket-dark.svg"><img src="docs/readme-icons/rocket-light.svg" width="14" align="center" alt=""></picture> Guided Onboarding

1. **Choose language** - Select from 44 languages. The entire UI switches instantly
2. **Select region** - Determines default cost database, currency, and classification standard
3. **Load cost database** - One-click import of CWICR pricing data for your region (120,000+ items)
4. **Import resource catalog** - Materials, labor, equipment, and pre-built assemblies
5. **Configure AI** *(optional)* - Enter an API key from any supported LLM provider
6. **Create your first project** - Set name, region, standard, and start estimating

---

### Capital plan

Rank projects against a limited yearly budget and see what happens if one is delayed. Guide: [English](docs/capital-plan.md) · [Deutsch](docs/capital-plan.de.md) · [Русский](docs/capital-plan.ru.md).

- **Yearly budget** - Funding per year and source, against the cost of each project spread over its years
- **What-if scenarios** - Copy a scenario, move a start year, compare the two. The baseline is never changed
- **Suggested funding** - Funds by priority, score and cost until a year runs out; you confirm before anything changes

## Quick Start

> **Problem while installing or starting?** See the **[installation help page](https://openconstructionerp.com/install-help)** or the same guide in the repo: [English](docs/INSTALL_TROUBLESHOOTING.md), [Deutsch](docs/INSTALL_TROUBLESHOOTING.de.md), [Русский](docs/INSTALL_TROUBLESHOOTING.ru.md).

### Easiest: download the desktop app (no Python, no setup)

Download the installer for your operating system, run it, and OpenConstructionERP opens as a native desktop app. No Python, no pip, no Docker, and no database to set up. Everything runs locally on your machine.

- **[Download for your platform](https://openconstructionerp.com/download)** picks the right file for your OS automatically.
- Or grab one straight from the **[latest release](https://github.com/datadrivenconstruction/OpenConstructionERP/releases/latest)**: Windows `.exe` installer, macOS `.dmg` (Apple Silicon), or Linux `.deb` / `.AppImage`.

**Your operating system will warn you before it runs the installer, and that is expected.** There is no code signing certificate for this project yet, so the desktop builds are unsigned. On Windows, SmartScreen says "Windows protected your PC"; choose More info, then Run anyway. If Windows 11 Smart App Control blocks the app instead, there is no Run anyway button, and [Windows blocks the app](docs/desktop/WINDOWS_BLOCKED.md) explains the options. On macOS, Gatekeeper says the developer cannot be verified; open the app from the Finder context menu and choose Open, or clear it with `xattr -dr com.apple.quarantine` on the installed app. Linux packages are unaffected. If you would rather verify the download than trust the warning, every release carries `SHA256SUMS` together with a Sigstore signature and certificate, so you can check the bytes you received against what the build produced.

There is no Intel macOS build at the moment. On an Intel Mac, use the pip or Docker route below.

The first launch takes about a minute while it sets up your local database, then every launch after that is fast. Open source under AGPL-3.0.

> **Prefer the command line?** The options below (pip, Docker, source) need Python 3.12+. Check with `python --version`.

### pip install (full app, one command)

```bash
pip install --upgrade openconstructionerp
openconstructionerp
```

That's it. The single wheel ships the backend plus the pre-built React frontend. The first run sets up a local embedded PostgreSQL database (no Docker, no setup), loads the demo data, opens your browser at **http://localhost:8080**, and you sign in with `demo@openconstructionerp.com` / `DemoPass1234!`. No Node.js and no extra services. Every later run, just type `openconstructionerp` again. [PyPI package](https://pypi.org/project/openconstructionerp/).

If the `openconstructionerp` command is not found after install, run it through Python instead. This works on every operating system and never depends on PATH:

```bash
python -m openconstructionerp
```

> **Deploying on a server?** By default the app listens on `127.0.0.1` (localhost only). To make it reachable over the network, add `--host 0.0.0.0`:
>
> ```bash
> openconstructionerp serve --host 0.0.0.0 --port 8080
> ```
>
> For a production setup with systemd and reverse proxy, see [docs/INSTALL_LINUX.md](docs/INSTALL_LINUX.md).

> **"Command not found"?** Install with [pipx](https://pipx.pypa.io) which handles PATH automatically. For platform-specific PATH setup and Ubuntu/Debian PEP 668 workarounds, see [docs/getting-started.md](docs/getting-started.md).
>
> If something looks off, run `openconstructionerp doctor` for a per-check OK/WARN/ERROR report.

### Alternative 1: One-line installer (handles PATH for you)

```bash
# Linux / macOS
curl -fsSL https://raw.githubusercontent.com/datadrivenconstruction/OpenConstructionERP/main/scripts/install.sh | bash

# Windows (PowerShell)
irm https://raw.githubusercontent.com/datadrivenconstruction/OpenConstructionERP/main/scripts/install.ps1 | iex
```

If you would rather not think about PATH at all, use this. It picks Docker if installed, otherwise uv, otherwise a dedicated Python virtual environment, installs OpenConstructionERP there, puts the `openconstructionerp` command on your PATH automatically, and finishes with a short panel showing the URL, the demo login and how to start. It also offers to launch right away. Open a new terminal afterwards and `openconstructionerp` just works. Runs at **http://localhost:8080**.

### Alternative 2: Docker

From the published image, no clone needed:

```bash
curl -fsSL https://raw.githubusercontent.com/datadrivenconstruction/OpenConstructionERP/main/docker-compose.quickstart.yml       -o docker-compose.yml
curl -fsSL https://raw.githubusercontent.com/datadrivenconstruction/OpenConstructionERP/main/docker-compose.quickstart.image.yml -o docker-compose.override.yml
echo "POSTGRES_PASSWORD=$(openssl rand -base64 24)" >  .env
echo "JWT_SECRET=$(openssl rand -hex 32)"           >> .env
docker compose pull app && docker compose up -d
```

Or build from source (also the better choice on Apple Silicon):

```bash
git clone https://github.com/datadrivenconstruction/OpenConstructionERP.git
cd OpenConstructionERP
echo "POSTGRES_PASSWORD=$(openssl rand -base64 24)" >  .env
echo "JWT_SECRET=$(openssl rand -hex 32)"           >> .env
make quickstart
```

Open **http://localhost:8080**. On Windows PowerShell, see [docs/getting-started.md](docs/getting-started.md#path-c-docker) for the same steps in PowerShell (a plain `>` there writes a `.env` that Compose cannot read).

### Alternative 3: Local development (clone + npm + uvicorn)

```bash
git clone https://github.com/datadrivenconstruction/OpenConstructionERP.git
cd OpenConstructionERP

# Install dependencies
pip install -e ./backend[server]
cd frontend && npm install && cd ..

# Start (Linux/macOS)
make dev

# Start (Windows - two terminals)
# Terminal 1: cd backend && uvicorn app.main:create_app --factory --reload --port 8000
# Terminal 2: cd frontend && npm run dev
```

Open **http://localhost:5173** - for hacking on the codebase. Requires Python 3.12+ and Node.js 22 or newer.

### Demo Accounts

Three demo accounts are created on first start. On a local install, sign in to any of them with the password `DemoPass1234!`. To set your own passwords (for a team demo or CI), set these before the first start:

- `DEMO_USER_PASSWORD` - admin (`demo@openconstructionerp.com`)
- `DEMO_ESTIMATOR_PASSWORD` - estimator (`estimator@openconstructionerp.com`)
- `DEMO_MANAGER_PASSWORD` - manager (`manager@openconstructionerp.com`)

| Account | Email | Password | Role |
|---------|-------|----------|------|
| Admin | `demo@openconstructionerp.com` | `DemoPass1234!` | Full access |
| Estimator | `estimator@openconstructionerp.com` | `DemoPass1234!` | Estimator |
| Manager | `manager@openconstructionerp.com` | `DemoPass1234!` | Manager |

> Demo accounts include 70 pre-loaded projects across 30+ countries with complete BOQs, schedules and cost models, from a Berlin residential block and a Paris school to a Dubai warehouse, a Shanghai office tower, a Toronto condo and a Guangzhou renovation.
>
> **Security note.** For any internet-exposed deployment, set the three
> `DEMO_*_PASSWORD` variables to strong, unique secrets, or disable demo
> accounts entirely with `DISABLE_DEMO_ACCOUNTS=1`. Do not reuse
> passwords from examples, screenshots, or earlier versions of this README.

---

## Tech Stack

| Layer | Technology | Purpose |
|-------|-----------|---------|
| Backend | Python 3.12+ / FastAPI | Async API, Pydantic v2 validation, modular architecture |
| Frontend | React 18 / TypeScript / Vite | SPA with code splitting, 44 languages |
| Database | PostgreSQL 16+ (only) | OLTP with JSON columns; an embedded PostgreSQL starts automatically for local dev, so there is no Docker, no separate database, and nothing to configure |
| UI | Tailwind CSS / AG Grid | Professional data grid, responsive design, dark mode |
| AI | Any LLM via REST API | Anthropic, OpenAI, Gemini, Mistral, Groq, DeepSeek |
| Vector Search | LanceDB (embedded) / Qdrant | Semantic cost item search, 384d or 3072d embeddings |
| CAD/BIM | [DDC Converters 2.0](https://github.com/datadrivenconstruction) | RVT, IFC, DWG → structured quantities |
| i18n | i18next | 44 languages, full RTL support |

## Architecture

> For a high-level system overview, stack diagram and module structure, see **[docs/architecture/OVERVIEW.md](docs/architecture/OVERVIEW.md)**.

### How the platform turns raw CAD/BIM into structured ERP data

OpenConstructionERP is built around **seven cooperating pipelines** that turn closed CAD/BIM files (RVT, IFC, DWG) into structured, queryable ERP data - without locking you into a proprietary stack. Every module in the platform plugs into one or more of these stages:

1. **Mining** - collect existing project data (CAD/BIM models, CDE drops, COBie deliverables) into a semi-structured pool. Handled by `cad`, `documents`, `bim_hub`, `file_search` modules + the **DDC Converters 2.0** (RVT/IFC/DWG → canonical JSON).
2. **QTO Check & Quantity Take-off rules** - apply rule sets per discipline / family / type to extract quantities deterministically. Handled by `takeoff`, `requirements`, `validation`, and the rule editor in `match-elements`.
3. **BlackBox (company standard)** - codify your firm's classifications, formulas, unit factors and assembly recipes as a single canonical rule book (COBie / CFIHOS / SQL / Excel / Access). Handled by `costs`, `assemblies`, `catalog`, `cost_intelligence`.
4. **New project modeling** - apply the BlackBox to a fresh model: geometry → filtering → grouping → verification → BOQ. Handled by `boq`, `projects`, `match-elements`, `clash`.
5. **BlackBox mapping** - map a new project's raw element list onto the canonical rule book via vector + lexical + rule-based matchers. Handled by `match-elements` (7-stage pipeline) + AI Estimate.
6. **Project-specific data (4D/5D/6D)** - derive scheduling, cost, hours, ordering and environmental footprint per group. Handled by `scheduling`, `advanced_schedule`, `5d_planner`, `risk`, `carbon`, `hse`.
7. **Saving data & Machine Learning** - persist project history into the database, data lake and ML models so each new project starts further ahead. Handled by `analytics`, `bi_dashboards`, `ai_chat`, `cost_intelligence`, and the rule-learning loop in `clash` and `match-elements`.

The right-hand side of the diagram is the **automatic data retrieval** layer that every UI surface (Dashboard, BOQ editor, /clash, /match-elements, /files, /scheduling) consumes: dashboards, calculations, reports, tables, charts, geometries, and ERP-ready exports - all driven from the same canonical store. The Machine-Learning column on the far right is where the platform progressively automates classification, parameterisation, recognition and marking, replacing manual steps (<picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/tools-dark.svg"><img src="docs/readme-icons/tools-light.svg" width="14" align="center" alt=""></picture>) with automatic steps (<picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/zap-dark.svg"><img src="docs/readme-icons/zap-light.svg" width="14" align="center" alt=""></picture>) over time.

### Technical stack

<details>
<summary>Plain-text version (for screen readers or non-Mermaid renderers)</summary>

```
┌──────────────────────────────────────────────────┐
│  Frontend (React SPA)                            │
│  TypeScript · Tailwind · AG Grid · PDF.js        │
└──────────────────┬───────────────────────────────┘
                   │ REST + SSE
┌──────────────────┴───────────────────────────────┐
│  Backend (FastAPI)                               │
│  190+ auto-discovered modules · Plugin system    │
├──────────────────────────────────────────────────┤
│  BOQ · Costs · Schedule · 5D · Validation · AI   │
│  Takeoff · Tendering · Risk · Reports · Catalog  │
│  Requirements · Markups · Punch List · BIM Hub   │
│  PropDev · Geo Hub · Coordination · Clash AI     │
│  Accommodation · Floating Chat · 26 widgets      │
├──────────────────────────────────────────────────┤
│  Database (PostgreSQL, embedded in dev)          │
│  Vector DB (LanceDB / Qdrant)                    │
│  CAD Converters (DDC Converters 2.0)             │
│  CV Pipeline (PaddleOCR + YOLOv11)               │
└──────────────────────────────────────────────────┘
```

</details>

---

## Project growth

Measured on 6 November 2026 from the GitHub API, PyPI and pypistats.org.

<table>
<tr>
<td align="center" width="12.5%">1,268 stars</td>
<td align="center" width="12.5%">395 forks</td>
<td align="center" width="12.5%">16 watchers</td>
<td align="center" width="12.5%">78 contributors</td>
<td align="center" width="12.5%">305 releases</td>
<td align="center" width="12.5%">19.1.0 latest&nbsp;release</td>
<td align="center" width="12.5%">235 issues&nbsp;closed</td>
<td align="center" width="12.5%">49,094 PyPI&nbsp;downloads</td>
</tr>
</table>

### Release downloads

GitHub release assets only, does not include <code>pip install</code> from PyPI, <code>docker pull</code> from GHCR, <code>git clone</code>, or direct downloads from <a href="https://openconstructionerp.com/download">openconstructionerp.com</a>.

[![Downloads (pepy · per month)](https://static.pepy.tech/personalized-badge/openconstructionerp?period=month&units=international_system&left_color=grey&right_color=blue&left_text=downloads%20(pepy%20%C2%B7%20per%20month))](https://pepy.tech/project/openconstructionerp)

### Stars

Every current stargazer on the day they starred, one step per day, with nothing smoothed or filled in between.

---

## Support the Project

OpenConstructionERP is built by [DataDrivenConstruction](https://datadrivenconstruction.io) and shaped by feedback from users worldwide. If you find it useful:

- ⭐ **[Star this repo](https://github.com/datadrivenconstruction/OpenConstructionERP)** - helps others discover the project
- <picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/comment-discussion-dark.svg"><img src="docs/readme-icons/comment-discussion-light.svg" width="14" align="center" alt=""></picture> **[Community chat (Telegram)](https://t.me/datadrivenconstruction)** - ask questions, share ideas, help others
- <picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/bug-dark.svg"><img src="docs/readme-icons/bug-light.svg" width="14" align="center" alt=""></picture> **[Report issues](https://github.com/datadrivenconstruction/OpenConstructionERP/issues)** - help us improve
- <picture><source media="(prefers-color-scheme: dark)" srcset="docs/readme-icons/briefcase-dark.svg"><img src="docs/readme-icons/briefcase-light.svg" width="14" align="center" alt=""></picture> **[Professional consulting](https://datadrivenconstruction.io/contact-support/)** - custom deployment, training, enterprise support

## Contributors

OpenConstructionERP is shaped by the people who report bugs, request features, and ask the sharp questions that push the platform forward. We credit every one of them. For supply-chain security, we do not merge external pull requests - see **[CONTRIBUTING.md](CONTRIBUTING.md)** for how contributions work here.

See **[CONTRIBUTORS.md](CONTRIBUTORS.md)** for the full list. Want to join it? [Open an issue](https://github.com/datadrivenconstruction/OpenConstructionERP/issues) or say hello in the [community chat](https://t.me/datadrivenconstruction).

## Security

Report vulnerabilities privately via [GitHub Security Advisories](https://github.com/datadrivenconstruction/OpenConstructionERP/security/advisories/new) or [info@datadrivenconstruction.io](mailto:info@datadrivenconstruction.io). See [SECURITY.md](SECURITY.md) for the full coordinated-disclosure policy and supported versions.

## AI disclaimer

AI suggestions produced by this software are preliminary estimates. A
qualified construction-estimation professional must verify all
quantities, classifications, and costs before any contractual or
tender-submission use. See [NOTICE](NOTICE) and [TERMS.md](docs/legal/TERMS.md) §4.

## Trademarks

All product names, logos, and trademarks referenced in this repository
are property of their respective owners. Any comparative references to
commercial categories or products are made for fair comparative purposes
based on publicly available information. OpenConstructionERP is an
independent project and is not affiliated with, endorsed by, or sponsored
by any third-party trademark owners. Full attributions in [NOTICE](NOTICE).

## Development and Contribution Model

We integrate all changes through one reviewed and tested development line to keep the many interconnected modules stable, secure and consistent, so the GitHub contributor list shows fewer names than the people who have shaped the project. See [CONTRIBUTING.md](CONTRIBUTING.md) for how to contribute.

## License

**AGPL-3.0** - see [LICENSE](LICENSE). Third-party attributions in
[NOTICE](NOTICE).

You can freely use, modify, and distribute this software. If you modify
and deploy it as a service, AGPL §13 requires you to make the
corresponding source code available under the same license.

For **commercial licensing**, which lifts the AGPL obligations on
OpenConstructionERP itself so you can deploy it closed-source, see
[COMMERCIAL-LICENSE.md](docs/legal/COMMERCIAL-LICENSE.md) or contact
[info@datadrivenconstruction.io](mailto:info@datadrivenconstruction.io).

No dependency we ship is under the AGPL, so the commercial license
covers everything a closed-source deployment runs. Releases up to and
including 18.7.0 shipped PyMuPDF, which is AGPL; PDF reading now goes
through pypdfium2 (Apache-2.0 / BSD-3-Clause). Section 4a of that file
has the details.

## Privacy and terms

- [PRIVACY.md](docs/legal/PRIVACY.md) - GDPR / UK DPA / CCPA / LGPD baseline
- [TERMS.md](docs/legal/TERMS.md) - terms of use for the hosted instance
- [COOKIES.md](docs/legal/COOKIES.md) - browser storage inventory
- [SECURITY.md](SECURITY.md) - responsible disclosure

---

<a href="https://x.com/datadrivenconst" target="_blank">
 <img src="https://img.shields.io/twitter/follow/datadrivenconst?logo=X&style=flat&color=%23f5f5f5" alt="Follow on X">
 </a>
 <a href="https://www.youtube.com/@datadrivenconstruction" target="_blank">
 <img src="https://img.shields.io/badge/YouTube-FF0000?logo=youtube&logoColor=white" alt="Subscribe on YouTube">
 </a>
 <a href="https://www.linkedin.com/company/78381569" target="_blank">
 <img src="https://custom-icon-badges.demolab.com/badge/LinkedIn-0A66C2?logo=linkedin-white&logoColor=fff" alt="Connect on LinkedIn">
 </a>
 <a href="https://www.youtube.com/watch?v=X06cIaroAeI" target="_blank">
 <img src="https://img.shields.io/badge/▶_Watch_demo-12_min_walkthrough-FF0000?logo=youtube&logoColor=white" alt="Watch the 12-minute walkthrough">
 </a>

Repository info

Default branch: main
Latest version: v19.2.0
Created: 02/04/2026
Last activity: 07/11/2026
License: AGPL-3.0
Open issues: 13
Watchers: 16

Contributors

datadrivenconstruction

9k contributions

github-actions[bot]

9 contributions

dependabot[bot]

4 contributions

arvildev

3 contributions

gbatkhuyag

3 contributions