User Tools

Site Tools


avril_developer_guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
avril_developer_guide [2024/06/15 10:23] – kalaschnikowavril_developer_guide [2024/06/15 10:24] (current) – kalaschnikow
Line 1: Line 1:
 +====== Avril Developer Guide ======
 +
 +===== Build and deploy Avril  =====
 +
 +The following docs should be updated/refreshed, but at the moment these are the best docs I have.
 +
 +[[Avril Deployment (without Docker Containerization)]]
 +
 +[[Avril on Docker]]
 +
 +
 +...
 +
 +===== Run locally =====
 +
 +==== Run Avril ====
 +  * normally it should already run, but if not, Start MySQL service : 
 +    * ''sudo service mysql start''
 +  * Start "Keycloak" JBoss with ''/home/kalaschnikow/Desktop/AvrilShortcuts/KeyCloak_4.6.0.desktop'' shortcut (or corresponding script) 
 +    * The Keycloak UI can be reached at http://localhost:8180
 +  * Run (not Debug!) "JBoss 10.1.0" run configuration from IntelliJ IDEA
 +    * The browser should start automatically with the address: http://192.168.178.148:8080/avril or  (the same as http://localhost:8080/avril) (old IP: 192.168.178.83)
 +  * (**Optional**) If you want to debug, start debug configuration "JBoss remote (kalaschnikow2017)" from IntelliJ IDEA
 +  * Logs are under: 
 +    * ''/mnt/sda4/development/_servers/wildfly-10.1.0.Final/standalone/log/'' 
 +
 +
 +==== Run Jrserver ====
 +
 +  * Open IntelliJ project 'jrserver.maven' (''/mnt/sda4/development/workspaces.jrserver/jrserver.maven'')
 +    * CAUTION: maybe the main branch should be "maven" and NOT "master"
 +  * Run the ''Main'' run configuration
 +  * Server should available under http://kalaschnikow2017:8080
 +    * e.g.: 
 +      * http://kalaschnikow2017:8080/bnav?id=38688
 +      * http://kalaschnikow2017:8080/geolead_install?id=38694
 +      * http://kalaschnikow2017:8080/geolead_install?id=38692
 +      * http://kalaschnikow2017:8080/skarabeus_technical_en?id=....
 +
 +
 +  * The actually used configuration (port, database connection, Avril URL etc.) is under:
 +    * ''config/app.config'' -> so normally ''jrserver.maven/config/app.config''
 +
 +
 +===== Avril projects and modules =====
 +
 +
 +==== AvrilServer project ====
 +
 +
 +  * the actual workspace lies under ''/mnt/sda4/development/workspaces/AvrilServer/''
 +
 +  * modules:
 +    * AvrilAdminWeb
 +      * seems to be a demo of an angular module
 +    * AvrilDock
 +      * Avril backend
 +      * It is a module which produces a war-file for Avril REST backend
 +    * AvrilWebAdmin
 +      * Avril web app
 +    * DockerImages
 +      * Description of all necessary docker images
 +    * jobdeleteutil
 +      * module for an utility which removes tasks from DB which were marked previously as deleted
 +    * questionnaireEditor
 +      * web app for questionnaire editor (seems to be not yet released)
 +
 +==== jrserver ====
 +
 +See [[jrserver]]
 +
 +==== Avril (Android) project ====
 +
 +...