# solop-develop/adempiere-grpc-server architecture

> Architecture diagram of the GitHub repository solop-develop/adempiere-grpc-server, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/solop-develop/adempiere-grpc-server
- Repository: https://github.com/solop-develop/adempiere-grpc-server

## Overview

##### Project type and purpose
- This is a backend microservice (“ADempiere gRPC Server”) written in Java 17 that exposes ADempiere ERP functionality over gRPC.
- It decouples ADempiere into multiple functional modules (Access, Dictionary, Business, POS, Workflow, Dashboarding, etc.) and is deployed via Docker (with Envoy as a gRPC proxy) and connects to a PostgreSQL database.

##### File structure
- Top level:
- src/main/proto – .proto definitions for every service (record management, reporting, accounting, etc.)
- src/main/java/org/spin/grpc – generated stubs + service logic packages (one package per `.proto` service)
- src/main/java/org/spin/base, /dictionary, /dashboarding, /pos, /server, /compiere, /legacy – core business logic, DB setup, utility classes, legacy adapter code
- docker-compose and docker folders – definitions for Postgres, Envoy proxy, the backend container, environment files
- build.gradle, gradlew, gradle.properties – build configuration
- Patches directory overlays customized model and process classes into the ADempiere core at runtime.

##### README for additional insights
- Describes running modes (gradle run, standalone YAML, Docker images)
- Highlights use of Envoy as a sidecar/proxy in front of the gRPC server
- Lists required Docker images (Postgres, backend, proxy, frontend)
- Emphasizes the gRPC + Protobuf technology stack and that the server entry point is `org.spin.server.AllInOneServices`

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Clients
    Clients["gRPC Clients (Vue, Other)"]:::network

    subgraph "Docker Compose Orchestration"
        direction TB
        %% Edge Proxy
        Envoy["Envoy Proxy (50059)"]:::network
        click Envoy "https://github.com/solop-develop/adempiere-grpc-server/blob/main/docker-compose/envoy/envoy.yaml"

        %% gRPC Server Container
        subgraph "ADempiere gRPC Server (Java Container)"
            direction TB
            entry["AllInOneServices (Entry Point)"]:::compute
            click entry "https://github.com/solop-develop/adempiere-grpc-server/blob/main/src/main/java/org/spin/server/AllInOneServices.java"
            
            proto["gRPC Service Definitions (.proto)"]:::compute
            click proto "https://github.com/solop-develop/adempiere-grpc-server/tree/main/src/main/proto"

            stubs["Generated gRPC Stubs & Interfaces"]:::compute
            click stubs "https://github.com/solop-develop/adempiere-grpc-server/tree/main/src/main/java/org/spin/grpc/service"
            
            logic["gRPC Service Logic Implementations"]:::compute
            click logic "https://github.com/solop-develop/adempiere-grpc-server/tree/main/src/main/java/org/spin/grpc/logic"
            
            subgraph "Domain Layer (Core Business Logic)"
                direction TB
                base["Base / Utility / Setup"]:::compute
                click base "https://github.com/solop-develop/adempiere-grpc-server/tree/main/src/main/java/org/spin/base"
                
                dict["Dictionary Module"]:::compute
                click dict "https://github.com/solop-develop/adempiere-grpc-server/tree/main/src/main/java/org/spin/dictionary"
                
                dash["Dashboarding Module"]:::compute
                click dash "https://github.com/solop-develop/adempiere-grpc-server/tree/main/src/main/java/org/spin/dashboarding"
                
                pos["Point-of-Sale Module"]:::compute
                click pos "https://github.com/solop-develop/adempiere-grpc-server/tree/main/src/main/java/org/spin/pos"
                
                legacy["Legacy ADempiere Adapter"]:::compute
                click legacy "https://github.com/solop-develop/adempiere-grpc-server/tree/main/src/main/java/org/adempiere/legacy"
                
                model["Compiere Domain Models"]:::compute
                click model "https://github.com/solop-develop/adempiere-grpc-server/tree/main/src/main/java/org/compiere/model"
            end
            
            dal["Data Access Layer (JDBC & HikariCP)"]:::compute
            click dal "https://github.com/solop-develop/adempiere-grpc-server/tree/main/src/main/java/org/spin/base/db"
            
            setup["SetupLoader & Runtime Patches"]:::compute
            click setup "https://github.com/solop-develop/adempiere-grpc-server/blob/main/src/main/java/org/spin/base/setup/SetupLoader.java"
            
            patches["Runtime Model & Process Patches"]:::compute
            click patches "https://github.com/solop-develop/adempiere-grpc-server/tree/main/src/patches"

            %% Build config
            build["Build Config (Gradle)"]:::compute
            click build "https://github.com/solop-develop/adempiere-grpc-server/blob/main/build.gradle"
        end

        %% Database Service
        DB[(PostgreSQL Database)]:::storage
        click DB "https://github.com/solop-develop/adempiere-grpc-server/blob/main/docker-compose/postgresql/initdb.sh"
    end

    %% Connections
    Clients -->|gRPC/TCP 50059| Envoy
    Envoy -->|gRPC/TCP 50059| entry

    entry --> proto
    entry --> setup

    proto --> stubs
    stubs --> logic

    logic --> base
    logic --> dict
    logic --> dash
    logic --> pos
    logic --> legacy
    logic --> model

    base --> dal
    dict --> dal
    dash --> dal
    pos --> dal
    legacy --> dal
    model --> dal

    dal --> DB

    setup --> base
    setup --> dict
    setup --> dash
    setup --> pos
    setup --> legacy
    setup --> model

    %% Styles
    classDef network fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef compute fill:#d4edda,stroke:#333,stroke-width:1px
    classDef storage fill:#ffe5b4,stroke:#333,stroke-width:1px
```
