Development Environment Setup
This step-by-step guide explains how to set up your development environment, using either Eclipse or IntelliJ for the backend and web UI and Android Studio for the mobile app. Please follow it strictly to ensure that your code adheres to our guidelines and that development will run smoothly.
...
Please note that these instructions are optimized for Windows and Linux systems. If you're developing on a Mac, we would be glad to get your feedback about extending this guide with OS-specific instructions through our GitHub Discussions/SORMAS Community platform (community.sormas.org).
Step 1: Check Out the SORMAS Repository
...
Download and install the latest IntelliJ IDEA Ultimate; (newer than version 2020-04-15 to enable debugging, see https://youtrack.jetbrains.com/issue/IDEA-216528)
Set the project SDK to the installed JDK.
...
Optional: Clone the SORMAS-Project repository if you haven't done so already.
Open the project in IntelliJ. Make sure the project is recognized by IntelliJ as a maven project; if not, right-click the pom.xml file in sormas-base and select Add as a maven project.
Make sure that under File -> Project Structure -> Modules all modules EXCEPT sormas-app are recognized; if not, add the missing modules with the + button.
...
Navigate to File -> Settings -> Plugins and make sure that Glassfish integration is enabled.
...
Make a copy of the sormas-base/dev.env.example, rename it to dev.env, and set GLASSFISH_DOMAIN_ROOT to the location of the SORMAS domain inside your Payara installation.
Run mvn install on the sormas-base project (e.g. by opening the Maven view and executing sormas-base -> Lifecycle -> install).
...
Alternatively, execute the dev/build.sh script. You can create a run configuration and use the Git bash executable as an interpreter to directly run it from the IDE.
Execute dev/deploy-serverlibs.sh script
Add a Payara server to IntelliJ:
Open Run -> Edit Configurations, add a new configuration and choose the Glassfish server template
Click on Configure next to the Application server and create a new server configuration by selecting your Payara installation directory
Check the After launch checkbox and specify the browser that you want SORMAS to open in once the server has been deployed
Enter http://localhost:6080/sormas-ui into the URL field
Make sure that the correct JRE is specified (your Java 11 JDK)
Enter the path to the SORMAS domain and the credentials that you've specified when setting up the server
Finally, it looks like
...
Open the Deployment tab and add the artifacts sormas-ear, sormas-rest, and sormas-ui (make sure to respect this order as there are dependencies between artifacts at startup)
Open the Logs tab and add a new log file pointing to the logs/server.log file in your SORMAS domain
Open the Startup/Connection tab and make sure that Pass environment variables are NOT checked; ignore warnings about the debug configuration not being correct
Open the config/domain.xml file in your domain directory and make sure that the java-config node contains the following code
...
Important: Whenever you do or pull changes in the sormas-api project that you want to use in the mobile app or that are referenced there already, you need to execute the dev/build.sh script to notify the sormas-app project of the changes.
...
...
| Info |
|---|
Under construction. Please check back later. |
SORMAS App (Android application)
...
Firebase Crashlytics & Performance Monitoring
SORMAS SERVER (LINUX)
...