How plataformaintegradainvestigadores/frontend-app works
Main Components
• Docker/Deployment Layer: Show the Dockerfile, docker-compose.yaml, .env, and nginx.conf. These files indicate that the application is containerized and likely served via an Nginx reverse proxy.
• Angular Application: The entire “src” folder encapsulates the Angular project. Within it, highlight:
• Core Modules (e.g., Auth, Consensus, Dashboard, Group, Profile, Search Engine) which follow a domain-driven design pattern (each module has its own domain, presentation, and sometimes use_cases).
• Shared Components and Services: These include shared modules (e.g., shared, d3, assets) used across multiple areas of the application.
• External Infrastructure: While the project itself is front-end heavy, note that there might be external services for administration (like the Scopus extraction mentioned in the README) and any backend API endpoints that serve data for these Angular modules.
Relationships and Interactions
• Container Flow: Start with the container level. The Docker image is built (via docker compose build) and then run (via docker compose up). Indicate how the Docker container hosts the Angular application and configures it with Nginx.
• The Auth module handles login/registration and authentication, impacting and gating access to other modules.
• The Consensus module (with its subcomponents for phases, discussion, and debate chats) handles collaborative or debate-driven functionality.
• The Dashboard module aggregates information and offers various dashboards (like affiliation and topic dashboards).
• The Group and Profile modules manage user groups and user profiles respectively.
• The Search Engine module provides a client interface for searching articles, authors, or relevant data, with additional admin interfaces.
• Shared and Utility Services: Show that common utilities (e.g., d3 visualizations, shared visuals, and domain services) are shared among several modules and thus connect across the application.
Important Architectural Patterns and Design Principles
• Modular/Domain-Driven Design: Each major feature (Auth, Consensus, Dashboard, Group, Profile, Search Engine) is encapsulated into its own module with a well-defined domain (entities, services, use-cases) and presentation layer. This ensures separation of concerns.
• Dependency Injection and Component-Based Structure: Angular’s best practices are followed; components, services, directives, and pipes are all defined in a modular manner.
• Containerized Deployment: Emphasize the use of Docker for deployment and environment consistency.
Relevant Technologies/Frameworks
• Angular (with its routing modules, component-based architecture)
• Docker and Docker Compose for containerization and deployment
• Nginx as a reverse proxy or web server for serving the Angular app from within the container
• TypeScript, along with additional Angular libraries and utilities for services and visuals (such as d3 for charts)
Following Elements
• Clear Labels: Each node (for example, “Docker Container”, “Nginx”, “Angular App”, “Auth Module”, “Dashboard Module”, “Shared Components”) should be clearly labeled.