Skip to content

Commit

Permalink
[#56873] Add instructions on how to develop on the BIM edition using …
Browse files Browse the repository at this point in the history
…Docker (#16302)

* [#56873] Add instructions on how to develop on the BIM edition using Docker

https://community.openproject.org/work_packages/56873

* Cleanup according to review comments
  • Loading branch information
wielinde authored Aug 2, 2024
1 parent cc4ccbc commit ea7a289
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docker/dev/backend/scripts/setup-bim
Original file line number Diff line number Diff line change
@@ -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
Expand Down
24 changes: 24 additions & 0 deletions docs/development/development-environment-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ea7a289

Please sign in to comment.