Setting Up a Local Development Environment

Developments
1

Hi,

I"m somewhat new to openbis and I’m trying to get a local dev env setup per the instructions found here .

There are appear to be a bunch of steps missing. For example: You need to set various database properties such as username and password for the AS and DSS before anything will start. Simply running:
openBISDevelopmentEnvironmentASPrepare
openBISDevelopmentEnvironmentASStart
openBISDevelopmentEnvironmentDSSStart

does not result in a functional development environment. In addition how is debugging performed? How are the LIMS-ELN modules built and loaded? How is UI development done such that changes can be integrated and debugged?

Sooo many unanswered questions on how to actually do development for openbis…

Would someone please direct me to any resources that could help in setting up a local development env?

Blessings,
David

2

Dear David,

I perfectly understand that learning how to develop openBIS and its core-plugins is challenging and even frustrating at first, is a large complex system.

To help you I have extended our readme file. Please have a look at Development of Core Plugins including Webapp Plugins in our readme file: Files · master · sispub / openbis · GitLab

I hope that answers your knowledge gaps.

Please ask further questions if something is not clear or let me know if this just solved it.

:slight_smile: :slight_smile: :slight_smile:

3

Hi,

I’m now in the same shoe as well and would appreciate you help!

It is really not clear how to actually run the server using IntelliJ, could not see an example Run configuration in the docs.

It is also not clear for me where

openBISDevelopmentEnvironmentASPrepare
openBISDevelopmentEnvironmentASStart
openBISDevelopmentEnvironmentDSSStart

need to be run? Should it be run in the command line or is it something to be run from the UI as suggested later in the “Development of NG UI” section.

I’m looking for a way to start the server in IntelliJ and be able to do step-by-step debugging as necessary, as well as reload changed classes via the debugger as much as possible to ease development.

Can you please give some hints how to actually achieve this?

4

Oh, I just found that in the documentation these all have a typo:

openBISDevelopementEnvironmentASPrepare
openBISDevelopementEnvironmentASStart
openBISDevelopementEnvironmentDSSStart

And that’s why I could not find the actual gradle tasks the docs are referring to.

5

Thanks for reporting the typos, I have corrected the readme now.

As you well listed, you can run those tasks in that order from IntelliJ.

You can also run them in debug mode if you want to debug the system.