How maximvill/programming-languages works
Project Type and Purpose
• This is a simple Java console‐application (“Лабораторная работа” for a programming languages course).
• It contains a single entry point (src/Main.java) and a minimal build/CI configuration.
File Structure Analysis
• Top-level:
• .github/workflows – CI pipelines (build.yml, main.yml)
• sonar-project.properties – SonarQube analysis settings
• README.md – high-level project description
• src/Main.java – application entry point
• There are no frontend or separate backend modules; it’s pure Java code packaged and executed on the JVM.
Key Components to Display
a. Source Code
• Directory: src/Main.java
• Represents the main Java application logic.
b. Build System / CI Pipelines
• GitHub Actions workflows (.github/workflows/*.yml)
• Responsible for compilation, testing, packaging.
c. Code Quality Analysis
• SonarQube (configured via sonar-project.properties)
• Scans code, reports metrics.
d. Runtime
• Java Virtual Machine (JVM) where Main.java executes.
e. External Systems (optional)
• GitHub repository as the code host
• SonarQube server where analysis results are published
Relationships and Data Flows
• Developer pushes code → triggers GitHub Actions.
• Build job: checks out code → compiles with javac → runs any tests.
• On successful build:
• Artifacts can be archived (if configured).
• SonarQube analysis job connects to Sonar server using sonar-project.properties.
• If all checks pass, the jar (or class files) can be deployed or made available for execution on a JVM.
Architectural Patterns / Design Principles
• Single‐module CLI application.
• CI/CD pipeline enforced by GitHub Actions.
• Continuous code quality monitoring via SonarQube.