How aastha22j02/addressbook-cicd-project works
Project type and purpose
• This is a Java-based, full-stack web application tutorial built with the Vaadin Framework.
• It demonstrates an address book UI (frontend) backed by a simple service layer and in-memory data model (backend).
• The build and deployment are managed via Maven (pom.xml, build.xml, build.properties) and can run on Jetty or Tomcat.
File structure
• Top-level build files: pom.xml, build.xml, build.properties, Jenkinsfile(s).
• Source code under src/main/java/com/edurekademo:
• tutorial/addressbook: UI classes (AddressbookUI.java, ContactForm.java)
• tutorial/addressbook/backend: domain model (Contact.java) and service (ContactService.java)
• helper & utilities: resource bundles, comparators, converters, logger, property loader.
• PMD rules under src/main/pmd for static analysis.
• Tests under src/test/java/com/edurekademo/utilities.
• No external database—data is held in memory via ContactService.
README for additional insights
• Confirms Vaadin UI, Java 8 requirement, Maven build, Jetty/Tomcat deployment.
• No mention of persistent storage—pure in-memory example.
• Indicates tutorial nature (not production grade).
Diagramming the architecture
• Web Browser (Client)
• Vaadin UI Layer
• AddressbookUI
• ContactForm
• Service Layer (ContactService)
• Domain Model (Contact)
• In-Memory Data Store (List<Contact>)
• Utilities Layer (comparators, converters, resource bundle, logger)
• Build and CI/CD (Maven, PMD, Jenkins)
• Application Server (Jetty or Tomcat)
• Browser ↔ HTTP ↔ Vaadin UI Layer
• UI Layer → calls → Service Layer
• Service Layer → reads/writes → In-Memory Data Store
• Service & UI → use → Utilities Layer for logging, i18n, conversion
• CI/CD Pipeline → triggers → Maven build → PMD static analysis → Docker/Tomcat deploy
c. Architectural patterns and principles
• Layered architecture: Presentation → Service → Domain/Data
• Dependency inversion: UI and Service depend on generic utility interfaces
• In-memory repository (no external DB) for tutorial simplicity
d. Key technologies
• Java 8, Vaadin Framework
• Maven (pom.xml), Ant (build.xml), Jenkins pipelines (Jenkinsfile)
• PMD for code quality
• Jetty/Tomcat for deployment