OpenProject development setup

OS/Method	Description
Ubuntu / Debian	Development setup on Linux
Docker	Development setup via Docker (quickest)
Docker (macOS)	macOS specific docker topics
macOS	Development setup on macOS

Start coding

Please have a look at our development guidelines for tips and guides on how to start coding. We have advice on how to get your changes back into the OpenProject core as smoothly as possible. Also, take a look at the docs directory in our sources, especially the how to run tests documentation (we like to have automated tests for every newly developed feature).

Troubleshooting

The OpenProject log file can be found in log/development.log.

If an error occurs, it should be logged there (as well as in the output to STDOUT/STDERR of the Rails server process).

npm ci / npm install fails on a package with an unreviewed install script? .npmrc sets strict-allow-scripts=true, which blocks any script not listed in the nearest package.json’s allowScripts map. Review the script, then run npm approve-scripts (or edit allowScripts directly) to record a decision.

Questions, comments, and feedback

If you have any further questions, comments, feedback, or an idea to enhance this guide, please tell us at the appropriate forum.