Quick Start
Get COREY running and open your first model in a few minutes.
The fastest way to run COREY is with Docker — one command, nothing else to install. If you're a developer who'd rather run it from source with Node and pnpm, see Local Setup instead.
Before you start
- Install Docker Desktop and make sure it's running.
- Have an
.ifcfile ready to open (any model exported from your BIM software).
Run COREY
Get the project
Download or clone the project, then open a terminal in the project folder.
Create your settings file
cp .env.example .envStart everything
This starts the app, its database, and file storage together:
docker compose --env-file .env -f docker/docker-compose.yml up --buildThe first run downloads and builds the images, so it takes a few minutes. Later runs start quickly.
Open your first model
Choose an .ifc file from your computer. The building loads into the 3D viewport
and you're ready to review.
Prefer a prebuilt image?
You can pull a ready-made image instead of building from source:
docker pull ghcr.io/jhjhjhjh/corey:latestWhat next?
Workflow
Walk through a complete model review, step by step.
Features
See everything COREY can do.
Clauses & Checks
Set up the rules your model must satisfy.
Running from source, or setting up the optional shared backend? See Local Setup.