How axelor/open-suite-webapp works
Project Type and Purpose
• This is a full-stack, modular Java web application (“Axelor Open Suite”) built on top of the Axelor Open Platform.
• Purpose: Provide a suite of business modules (CRM, Sales, Finance, HR, Project, Inventory, Production, multi-company/multi-currency/multi-lingual) in a single, extensible system.
File Structure Analysis
• Top‐level build files:
• build.gradle, settings.gradle, gradle.properties, Gradle wrapper (gradlew, gradle/wrapper/*)
• buildSrc/…: custom Gradle tasks for XML checks, CSV checks, changelog generation
• Source code layout:
• modules/axelor-open-suite: submodule directory containing all business module code
• src/main/java (not shown, but implied by persistence.xml under src/main/resources)
• src/main/resources: configuration (persistence.xml, axelor-config.properties), i18n CSVs
• No explicit “frontend” vs. “backend” directories: backend Java under modules, frontend static under webapp.
Insights from README
• Confirms modular architecture via Git submodules
• Installation requires cloning submodules, building with Gradle
• Built on Axelor Open Platform (likely providing core services, REST endpoints, web framework)
Main Components
a. Client / Browser
– Renders HTML/CSS/JS (Leaflet maps, NVD3 charts)
b. Web Server / Application Container
– Serves static webapp files
– Hosts Java servlets/controllers (Spring MVC or equivalent)
c. Business Modules
– CRM, Sales, Finance, HR, Project, Inventory, Production
– Packaged as submodules loaded at runtime
d. Service Layer
– Java services (transactional business logic)
e. Persistence Layer
– JPA/Hibernate (configured via META-INF/persistence.xml)
– RDBMS (e.g., PostgreSQL or MySQL)
f. Build & Deployment Pipeline
– Gradle core + custom buildSrc tasks (XML checks, changelog generation)
– CI/CD integration
g. External Services
– Map tile providers (OpenStreetMap, Google Maps APIs)
– Email/SMS gateways (if modules use notifications)
– Third-party REST APIs
Relationships and Data Flows
• User → (HTTPS) → Web Server → Router/Controller
• Controller → Service Layer → Repository Layer → Database
• Service Layer ↔ External APIs (maps, notifications)
• Static Asset Fetch: Browser GET /webapp/* → Web Server
Architectural Patterns & Design Principles
• Modular monolith: each business domain packaged as a submodule
• Layered architecture: Presentation → Controller → Service → Repository
• Convention-over-configuration via Axelor Platform
• Gradle build with custom tasks enforces quality checks (XML, CSV, changelog)
Key Technologies/Frameworks
• Java 8+ / Jakarta EE or Spring MVC
• Gradle (with buildSrc extension)
• JPA/Hibernate
• Web UI: HTML5, CSS, JavaScript (Leaflet, NVD3)
• Git submodules for modular source
• RDBMS (PostgreSQL, MySQL, etc.)