From f00c0508c032492e2b60951450b52d4c81048066 Mon Sep 17 00:00:00 2001 From: Wieland Lindenthal Date: Thu, 1 Aug 2024 16:44:24 +0200 Subject: [PATCH 1/2] [#56873] Add instructions on how to develop on the BIM edition using Docker https://community.openproject.org/work_packages/56873 --- docker/dev/backend/scripts/setup-bim | 7 +++++ .../development-environment-docker/README.md | 26 +++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/docker/dev/backend/scripts/setup-bim b/docker/dev/backend/scripts/setup-bim index 34933eba8419..b76f80fa39fd 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 with 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..ebf7e72e8b04 100644 --- a/docs/development/development-environment-docker/README.md +++ b/docs/development/development-environment-docker/README.md @@ -23,14 +23,40 @@ 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 You can run tests inside the `backend-test` container. You can run specific tests, too. From d3ec2ee14652f89bf951681f87cc86a6a7f82289 Mon Sep 17 00:00:00 2001 From: Wieland Lindenthal Date: Fri, 2 Aug 2024 15:57:41 +0200 Subject: [PATCH 2/2] Cleanup according to review comments --- docker/dev/backend/scripts/setup-bim | 2 +- docs/development/development-environment-docker/README.md | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/docker/dev/backend/scripts/setup-bim b/docker/dev/backend/scripts/setup-bim index b76f80fa39fd..4ec396b503a2 100755 --- a/docker/dev/backend/scripts/setup-bim +++ b/docker/dev/backend/scripts/setup-bim @@ -3,7 +3,7 @@ # 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 with like this to enable your Docker based development setup to convert IFC\ +# 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 diff --git a/docs/development/development-environment-docker/README.md b/docs/development/development-environment-docker/README.md index ebf7e72e8b04..d74283ec7735 100644 --- a/docs/development/development-environment-docker/README.md +++ b/docs/development/development-environment-docker/README.md @@ -55,8 +55,6 @@ 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 You can run tests inside the `backend-test` container. You can run specific tests, too.