references/openproject
1
0
Fork 0
mirror of https://github.com/opf/openproject.git synced 2026-06-14 03:30:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

[#56873] Add instructions on how to develop on the BIM edition using Docker (#16302)

Browse Source 
* [#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
This commit is contained in:
Wieland Lindenthal
2024-08-02 16:02:57 +02:00
committed by GitHub
parent cc4ccbca65
commit ea7a289f3b
2 changed files with 31 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docker/dev/backend/scripts/setup-bim
+7
View File
@@ -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
docs/development/development-environment-docker/README.md
+24
View File
@@ -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