diff --git a/docker/dev/backend/scripts/setup-bim b/docker/dev/backend/scripts/setup-bim index 34933eba8419..4ec396b503a2 100755 --- a/docker/dev/backend/scripts/setup-bim +++ b/docker/dev/backend/scripts/setup-bim @@ -1,5 +1,12 @@ #!/bin/sh +# This script installs all the required dependencies and command line tools to convert IFC files into XKT files, +# so that the BIM models can be viewed via the Xeokit BIM viewer. +# +# Run this script on your worker container like this to enable your Docker based development setup to convert IFC +# files to XKT: +# $ docker compose exec -u root worker setup-bim + apt-get install -y wget unzip # https://learn.microsoft.com/en-gb/dotnet/core/install/linux-debian#debian-12 diff --git a/docs/development/development-environment-docker/README.md b/docs/development/development-environment-docker/README.md index 812060b70d1e..d74283ec7735 100644 --- a/docs/development/development-environment-docker/README.md +++ b/docs/development/development-environment-docker/README.md @@ -23,12 +23,36 @@ To get right into it and just start the application you can just do the followin git clone https://github.com/opf/openproject.git cd openproject cp .env.example .env +``` + +Optional: In case you want to develop on the OpenProject *BIM Edition* you need to set the +environmental variable accordingly in your `.env` file. + +```shell +OPENPROJECT_EDITION=bim +``` + +Then continue the setup: + +```shell cp docker-compose.override.example.yml docker-compose.override.yml docker compose run --rm backend setup docker compose run --rm frontend npm install docker compose up -d frontend ``` +Optional: In case you want to develop on the OpenProject *BIM Edition* you need +to install all the required dependencies and command line tools to convert IFC +files into XKT files, so that the BIM models can be viewed via the *Xeokit* +BIM viewer. As the conversions are done by background jobs you need install +those tools within the `worker` service: + +```shell +docker compose exec -u root worker setup-bim +``` + +Please find below instructions on how to start and stop the workers. + Once the containers are done booting you can access the application under `http://localhost:3000`. ### Tests