How iitc-ce/ingress-intel-total-conversion works
Primary Components
• Browser Extension/Core (Frontend):
• Subcomponents such as the mapping/data-rendering layer, communication modules with the Ingress intel map, UI components (panes, sidebar, dialogs), and integration with third-party libraries (e.g., Leaflet, jQuery).
• Plugin Architecture:
• “plugins” directory and its extensive collection of feature extensions. Indicate that IITC is designed with a plugin framework and that these plugins can augment default behavior.
• Existence of “pluginwrapper.py” and similar files, which indicate tooling for wrapping or injecting plugins.
• Mobile Application:
• Mobile app component (under “mobile”). This Android project (Java-based) mirrors much of the IITC functionality for mobile users.
• Major parts such as the application class (IITC_Application.java), UI activities (e.g., IntroActivity, ShareActivity), service components (NotificationHelper, MapSettings), and asynchronous tasks.
• External Libraries and Assets:
• “core/external” and “assets” directories. These include third-party libraries (e.g., Leaflet, autolink, jquery-ui) as well as images and CSS used across the project.
• Build and Deployment Pipelines:
• CI/CD aspects by including the GitHub workflows (found in “.github/workflows”) and the build scripts (e.g., build.py, build_mobile.py), which automate the build process.
• “fastlane” directory for mobile builds, representing how the Android app is packaged and deployed.
• Testing and Code Quality:
• A testing component (from the “test” directory for JS unit tests) and linters/config files (eslint.config.js, package.json, prettierrc.json, etc.) to show how code quality is managed.
Relationships and Interactions
• Within the Browser Client:
• Primary flow from user interaction (UI components) to core functionality (e.g., map rendering, dialog management, request handling).
• That many of the modules communicate by sharing cached data, event hooks, and asynchronous requests.
• Plugin System:
• Mobile Application:
• Android application’s architecture with its distinct layers (UI layer, logic/service layer, and system integrations).
• Interactions such as communication between the Java activities, asynchronous tasks (for updating maps and scripts), and external mapping libraries (provided within the mobile project).
• Build/Deployment Pipeline:
Architectural Patterns and Design Principles
• Modularity and Separation of Concerns:
• Clear separation between the core logic (JavaScript modules handling map data, UI, etc.) and the plugins that can extend functionality.
• Client-Side Enhancement:
• That IITC works as a browser add-on; therefore, much of the design is focused on enhancing an existing web application (the Ingress Intel Map) via injected or dynamic UI components.
• Cross-Platform Strategy:
• For mobile, show how a parallel but native implementation coexists with the browser add-on. This illustrates the project’s design for cross-platform support, with shared design principles even if implemented in different languages.