How jesusalbujas/frontend-university-project works
Main Components
a. User Interface (Frontend): Represent the Vue.js application itself. Indicate that it uses Element UI, dynamic sidebars, i18n, routing (vue-router) and state management (Vuex). Point out that the “src” folder covers the entry file (main.js), App.vue, the router, the store, and many granular UI components (for forms, dashboards, modals, tables, etc.).
b. API Layer / Proxy: A critical part of this system is the communication between the Vue UI and the back‐end. The README and Docker configuration mention an “ADempiere-UI-Gateway” (or proxy API) which forwards requests to the ADempiere gRPC Server. This should be depicted as a separate component.
d. Deployment & Build Infrastructure: Include components such as the Docker container setup (Dockerfile, docker-compose, Kubernetes manifests) and configuration directories. These work together to build, test, and deploy the front-end in multiple environments (dev, stage, production).
e. Supporting Tools: Highlight that unit testing (Jest), ESLint configuration, and build scripts (babel, vue.config.js) form part of the development/test pipeline.
Component Relationships and Interaction
• The user interacts with the browser where the Vue application (mounted from public/index.html) is running.
• The Vue app’s front-end components make REST/gRPC calls (through the API layer/proxy) to the back-end services.
• The API layer bridges the calls between the Vue UI and the ADempiere gRPC Server.
• The data from the backend is then processed within Vuex (state management) and rendered by the dynamic Vue components.
• The system deployment infrastructure (Docker, Kubernetes) packages the Vue application, configures environment variables (e.g., API_URL, PUBLIC_PATH, TZ), and wires the whole service together.
Architectural Patterns and Design Principles
• The system follows a component-based Single Page Application (SPA) design pattern.
• There is a clear separation between presentation (components in “src/components” and “src/views”), state management (in “src/store”), routing (in “src/router”), and API integration (in “src/api”).
• The use of Plop templates hints at a modular design approach for creating reusable components, stores, and views.
• The deployment pipeline leverages containerization (Docker, Kubernetes) for consistent development and production environments.
Detailing Specific to This Project
• “src” directory as the heart of the application – showing its subdirectories such as “api”, “components”, “views”, “router”, and “store”.
• Mention that the Docker-related files like docker-compose.yaml, Kubernetes manifests, and build scripts in the “build” and “config” directories are used for deployment orchestration.
• Documentation (“docs” folder) that supports understanding of components like smart browser, workflows, and other ADempiere-supported modules.