Skip to content

BimZone — Start here

Written against the live Production deployment (bim.addmedad.top) on 2026-09-17 — commit ab43fdf, web bundle index--ho5O1tU.js. Every screenshot in docs/images/ is a real capture of that UI, every control name is quoted from the shipped interface, and nothing here describes a feature that is not available today. When a workflow needs something external (a vendor account, a credential, a DNS record) the page says so.

BimZone is a self-hosted BIM collaboration platform for construction projects: you upload IFC models, review them in the browser, and run the project's coordination, field, document-control, planning and cost workflows against those models. It is bilingual (English and Arabic, right-to-left) and organised as workspace → projects → modules. Every record — an issue, a clash, an inspection, an asset — attaches to model elements, so a change made in one module is visible from the others.

The new-customer journey

Follow these in order the first time. Each step links to the page that explains the module in full.

# Step Read
1 Understand what BimZone is, sign in, find your way around Workspace & projects
2 Start a project and add people to it Workspace & projects › Projects
3 Add or import a model Models & viewer › Models
4 Review the model Models & viewer › 3D viewer
5 Use the tree, groups, saved views and split view Models & viewer › Tree, groups, views
6 Work with issues, RFIs and clashes Issues, RFIs & clashes
7 Use the CDE: documents, sheets, transmittals CDE, documents & sheets
8 Field work: inspections, WIRs, MARs, safety, diary, capture Field
9 Check a model against an IDS, then 4D schedule and 5D cost 4D & 5D
10 Reports, analytics, map, twin, assets, sensors Reports & analytics
11 Connect integrations Integrations
12 Automate routine reactions Automation
13 Use the Copilot where it is enabled Copilot

Role guides

Pick the one that matches your job. Each maps the persona onto the real BimZone roles and lists the modules and approval duties that person owns.

Reference

For the people who run the platform

Operator and administrator runbooks. These assume shell access to the deployment.

Runbook What it covers
Deployment verification Proving a push actually reached Production: bundle hash, /api/health, api container, worker
Migrations How schema changes are applied, checked and rolled back
Backups & restore Backup architecture, PITR, standby failover, monthly drill
Credentials & secrets Where every secret lives, the compose allowlist trap, rotation, what must never be in git or logs
Copilot credentials Providers, env vars, model selection, failover, the 503 "no model configured" state
ACC / Procore activation Vendor app registration, OAuth, webhooks
APS activation Autodesk Platform Services model derivative
Monitoring & health Health endpoints, backup status, queue depth, SLOs and alerts
Production recovery What to do when the site, the api, the worker or the database is down
Test-data cleanup Removing pilot and test records from a live project
Known external blockers Things that cannot be fixed from inside the codebase, and who owns each

Security posture and disclosure: SECURITY.md. Service objectives: operations/SLO.md.

How this documentation is kept honest

  • Module pages all follow the same twelve headings (what it does → where to go next), and a structural test in apps/web/tests/structural/docs-completeness.test.ts fails the build if a module section drops one, a link or image stops resolving, or an anchor names a heading that does not exist.
  • Every role and approval statement was read back against the server's requireProjectRole and maker-checker guards by an independent review before this version shipped; where a UI string promises more than a route provides, the page says so.
  • Control names are quoted from the shipped UI (apps/web/src/lib/i18n.ts and the page sources), not from design intent.
  • Screenshots come from Production; when a screen needs data that Production does not have, the text says so and describes the control from source.
  • These pages are published at https://doc.addmedad.top on every push (the docs service, built by docs-site/), and the app links there from the top bar's book icon and the dashboard's "New here? Start with the guide". A page missing from the site's navigation fails the build.