# venkeystore/maven-project architecture

> Architecture diagram of the GitHub repository venkeystore/maven-project, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/venkeystore/maven-project
- Repository: https://github.com/venkeystore/maven-project

## Overview

##### Project type and purpose
- This is a multi-module Maven project for a simple Java web application, intended as sample code for a Jenkins/CI-CD course.
- It has two modules:
- server – a standalone Java library (“business logic” / Greeter class + unit tests)
- webapp – a Java web application (JSP front end + web.xml)
- The root POM ties them together, and there’s an Azure Pipelines YAML for CI/CD.

##### File structure
- Top‐level modules:
- pom.xml (parent POM)
- server/ (library module)
- webapp/ (WAR-packaging module)
- server/src/main/java/com/example/Greeter.java – core logic
- webapp/src/main/webapp/index.jsp – presentation
- webapp declares a dependency on the server module in its POM.
- azure-pipelines.yml – CI/CD pipeline definition
- .gitignore, README.md – repo metadata

##### README
- Confirms it’s supporting a Jenkins/DevOps course—so CI/CD flow is essential.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Source Repository
    GitRepo["Git Repository"]:::source
    GitRepo -->|contains| ParentPOM["pom.xml"]:::source
    GitRepo -->|contains| Readme["README.md"]:::source
    GitRepo -->|contains| GitIgnore[".gitignore"]:::source
    GitRepo -->|contains| ServerPOM["server/pom.xml"]:::source
    GitRepo -->|contains| GreeterClass["server/src/main/java/com/example/Greeter.java"]:::source
    GitRepo -->|contains| TestGreeter["server/src/test/java/com/example/TestGreeter.java"]:::source
    GitRepo -->|contains| ServerDoc["server/src/site/apt/index.apt"]:::source
    GitRepo -->|contains| WebappPOM["webapp/pom.xml"]:::source
    GitRepo -->|contains| IndexJSP["webapp/src/main/webapp/index.jsp"]:::source
    GitRepo -->|contains| WebXML["webapp/src/main/webapp/WEB-INF/web.xml"]:::source
    GitRepo -->|contains| WebappDoc["webapp/src/site/apt/index.apt"]:::source
    GitRepo -->|contains| AzureYML["azure-pipelines.yml"]:::source

    %% CI/CD Pipeline
    subgraph "CI/CD System"
        AzurePipelines["Azure Pipelines YAML"]:::cicd
        BuildAgent["Build Agent (Maven)"]:::cicd
    end
    GitRepo -->|trigger build| AzurePipelines
    AzurePipelines -->|"mvn compile & test"| BuildAgent

    %% Artifacts
    subgraph ArtifactsRepo
        ArtServer["server.jar"]:::artifact
        ArtWeb["webapp.war"]:::artifact
    end
    BuildAgent -->|"package server.jar"| ArtServer
    BuildAgent -->|"package webapp.war"| ArtWeb
    ArtServer -->|"dependency"| ArtWeb

    %% Deployment
    subgraph "Deployment Environment"
        Tomcat["Tomcat (Servlet Container)"]:::runtime
        subgraph "Inside Tomcat"
            JSP["index.jsp (View)"]:::runtime
            GreeterRuntime["Greeter.java (Business Logic)"]:::runtime
        end
    end
    ArtWeb -->|"deploy webapp.war"| Tomcat

    %% Runtime Flow
    User["End User (Browser)"]:::user
    User -->|"HTTP Request"| Tomcat
    JSP -->|"invoke Greeter"| GreeterRuntime

    %% Click Events
    click ParentPOM "https://github.com/venkeystore/maven-project/blob/master/pom.xml"
    click Readme "https://github.com/venkeystore/maven-project/blob/master/README.md"
    click GitIgnore "https://github.com/venkeystore/maven-project/blob/master/.gitignore"
    click AzureYML "https://github.com/venkeystore/maven-project/blob/master/azure-pipelines.yml"
    click ServerPOM "https://github.com/venkeystore/maven-project/blob/master/server/pom.xml"
    click GreeterClass "https://github.com/venkeystore/maven-project/blob/master/server/src/main/java/com/example/Greeter.java"
    click TestGreeter "https://github.com/venkeystore/maven-project/blob/master/server/src/test/java/com/example/TestGreeter.java"
    click ServerDoc "https://github.com/venkeystore/maven-project/blob/master/server/src/site/apt/index.apt"
    click WebappPOM "https://github.com/venkeystore/maven-project/blob/master/webapp/pom.xml"
    click IndexJSP "https://github.com/venkeystore/maven-project/blob/master/webapp/src/main/webapp/index.jsp"
    click WebXML "https://github.com/venkeystore/maven-project/blob/master/webapp/src/main/webapp/WEB-INF/web.xml"
    click WebappDoc "https://github.com/venkeystore/maven-project/blob/master/webapp/src/site/apt/index.apt"

    %% Styles
    classDef source fill:#BBDEFB,stroke:#333,stroke-width:1px
    classDef cicd fill:#C8E6C9,stroke:#333,stroke-width:1px
    classDef artifact fill:#FFE0B2,stroke:#333,stroke-width:1px
    classDef runtime fill:#FFCC80,stroke:#333,stroke-width:1px
    classDef user fill:#D1C4E9,stroke:#333,stroke-width:1px
```
