# mapa-de-carreras/mapa-de-carreras-frontend architecture

> Architecture diagram of the GitHub repository mapa-de-carreras/mapa-de-carreras-frontend, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-11-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mapa-de-carreras/mapa-de-carreras-frontend
- Repository: https://github.com/mapa-de-carreras/mapa-de-carreras-frontend

## Overview

##### Project Type and Purpose
- This is a single‐page application (SPA) built with React, TypeScript and Vite.
- It targets the browser only (no embedded backend code here), consuming external REST APIs (see src/shared/apis).
- Docker and Docker Compose are used to spin up both development (with HMR via Vite) and production (static assets served via Nginx) environments.

##### File Structure Analysis
- Top level contains Dockerfiles (dev & prod), docker-compose files, Vite config, Nginx config, package.json, and static index.html.
- src/ divides into:
- index/ – bootstrap (Router, Home).
- modules/ – feature‐oriented pages (academic and users subtrees).
- shared/ – cross‐cutting utilities:
– apis/ – wrappers around remote endpoints (carreras, constantes, generics).
– services/ – auth flows (login, logout, refresh) and route definitions.
– components/ – UI primitives, layout (Navbar, Modal, Tabla), providers (AuthProvider, ThemeProvider), hooks, common libs.
– data/ & types/ – static lists & TS interfaces.
- Config files define linting, TypeScript, Vite bundling and Docker/Nginx behavior.

##### README Insights
- Provides commands to spin up dev (Vite) vs prod (static build + Nginx).
- Emphasizes React + TypeScript + Vite minimal template and ESLint/Prettier.

a. Main Components
- Developer Machine – runs either Vite Dev Server or builds production image.
- Vite Dev Server – HMR server on port 3000 (docker-compose.dev).
- Docker (Production) – Nginx container serving static /dist assets.
- Browser – end user interface.
- External REST APIs – authentication service, academic service, user service (hosted elsewhere).
- CI/CD (optional) – build pipeline that generates Docker image and pushes to registry.

b. Relationships & Interactions
1. Developer edits code → Vite watches & hot‐reloads in browser.
2. In production, assets are built (vite build) → bundled into /dist → served by Nginx.
3. Browser sends HTTP(S) requests to external backend endpoints via shared/apis wrappers.
4. Auth flows:
– login/logout/refresh endpoints handle tokens stored by AuthProvider.
– Protected routes (GuestRoute, ProtectRouter) guard module pages.
5. Modules import shared components, services, and types to render pages.

c. Architectural Patterns & Principles
- Feature Modules – pages and their subcomponents grouped by domain under src/modules.
- Shared Library – reusable UI components, hooks, utils, and data under src/shared.
- Provider Pattern – context providers for auth and theming.
- Atomic UI Components – base primitives under ui/ that compose higher‐level components.
- Container vs Presentational – modules/pages orchestrate data fetch via services; shared/components render UI.

d. Key Technologies
- React + TypeScript + Vite (frontend framework & bundler)
- Docker & Docker Compose (dev & prod containerization)
- Nginx (static asset server, reverse proxy)
- ESLint/Prettier (code consistency)

##### Final Recommendations
- Build steps: “vite build → /dist” and Dockerfile layering.
- Validate with the team that all external endpoints are represented.

## Diagram (Mermaid)

```mermaid
graph TD
    subgraph "Development Environment"
        Dev["Developer Machine"]:::infra
        Vite["Vite Dev Server<br/>(HMR:3000)"]:::infra
    end

    subgraph "Production Environment"
        Nginx["Nginx Server<br/>(Static /dist)"]:::infra
        DockerProd["Docker Prod"]:::infra
    end

    Browser["Browser"]:::infra

    subgraph "Frontend App"
        subgraph "src/index"
            Router["Router"]:::app
            Home["Home"]:::app
        end

        subgraph "Feature Modules"
            subgraph "Academic Module"
                Degree["DegreePage"]:::app
                Inst["InstitutesPage"]:::app
            end
            subgraph "Users Module"
                Login["LoginPage"]:::app
                Logout["LogoutPage"]:::app
                Notif["NotificacionesPage"]:::app
                Rec1["RecoverPassword1"]:::app
                Rec2["RecoverPassword2"]:::app
                Rec3["RecoverPassword3"]:::app
                RecUser["RecoverUsername"]:::app
                CreateU["UserCreate"]:::app
                DetailU["UserDetail"]:::app
                EditU["UserEdit"]:::app
            end
        end

        subgraph "Shared Library"
            subgraph "APIs"
                Carr["carreras.ts"]:::app
                Const["constantes.ts"]:::app
                Gen["generics.ts"]:::app
            end
            subgraph "Services"
                LoginS["login.ts"]:::app
                LogoutS["logout.ts"]:::app
                RefreshS["refresh.ts"]:::app
                TypesS["types.ts"]:::app
                RoutesS["routes.ts"]:::app
            end
            subgraph "Components"
                Navbar["Navbar"]:::app
                NavItem["NavItem"]:::app
                Modal["ModalGenerico"]:::app
                Tabla["Tabla"]:::app
                Tarjeta["TarjetaUsuario"]:::app
                subgraph "Providers"
                    AuthProv["AuthProvider"]:::app
                    GuestR["GuestRoute"]:::app
                    ProtectR["ProtectRouter"]:::app
                    ThemeProv["ThemeProvider"]:::app
                end
                subgraph "Atomic UI"
                    Btn["button.tsx"]:::app
                    Input["input.tsx"]:::app
                    TableUI["table.tsx"]:::app
                end
            end
            subgraph "Data & Types"
                DataCarr["carreras.ts"]:::app
                DataInst["institutos.ts"]:::app
                TypeCarr["carrera.ts"]:::app
                TypeInst["instituto.ts"]:::app
            end
        end
    end

    subgraph "External Services"
        AuthSvc["Authentication Service"]:::external
        AcadSvc["Academic Service"]:::external
        UserSvc["User Service"]:::external
    end

    Dev --> Vite --> Browser
    Browser -->|loads SPA| Router
    Browser --> Nginx --> Browser
    Browser --> AuthSvc
    Browser --> AcadSvc
    Browser --> UserSvc

    Router --> ProtectR
    ProtectR --> Degree
    ProtectR --> Inst
    ProtectR --> Logout
    GuestR --> Login

    Degree -->|uses| Carr
    Inst -->|uses| Carr
    Login -->|uses| LoginS
    Logout -->|uses| LogoutS
    RefreshS -->|refreshes| AuthSvc

    Carr -->|wraps| AcadSvc
    Const -->|wraps| AcadSvc
    Gen -->|generic calls| UserSvc

    Degree -->|imports UI| Tabla
    Inst -->|imports UI| Modal
    Login -->|imports UI| Input
    Logout -->|imports UI| Tarjeta

    AuthProv --> Router
    ThemeProv --> Router

    classDef infra fill:#c2f0c2,stroke:#2d6a4f,color:#1b4332
    classDef app fill:#bee5eb,stroke:#045275,color:#073b4c
    classDef external fill:#ffe5b4,stroke:#e76f51,color:#9d0208

    click Router "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/index/Router.tsx"
    click Home "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/index/Home.tsx"
    click Dev "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/Dockerfile.dev"
    click DockerProd "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/tree/main/Dockerfile"
    click Vite "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/vite.config.ts"
    click Nginx "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/nginx.conf"
    click Degree "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/modules/academic/DegreePage/DegreePage.tsx"
    click Inst "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/modules/academic/InstitutesPage/InstitutesPage.tsx"
    click Login "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/modules/users/LoginPage/LoginPage.tsx"
    click Logout "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/modules/users/LogoutPage/LogoutPage.tsx"
    click Notif "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/modules/users/NotificacionesPage/NotificacionesPage.tsx"
    click Rec1 "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/modules/users/RecoverPassword/RecoverPassword1.tsx"
    click Rec2 "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/modules/users/RecoverPassword/RecoverPassword2.tsx"
    click Rec3 "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/modules/users/RecoverPassword/RecoverPassword3.tsx"
    click RecUser "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/modules/users/RecoverUserName/RecoverUsername.tsx"
    click CreateU "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/modules/users/UserCreate/UserCreate.tsx"
    click DetailU "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/modules/users/UserDetail/UserDetail.tsx"
    click EditU "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/modules/users/UserEdit/UserEdit.tsx"
    click Carr "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/apis/carreras.ts"
    click Const "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/apis/constantes.ts"
    click Gen "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/apis/generics.ts"
    click LoginS "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/services/auth/login.ts"
    click LogoutS "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/services/auth/logout.ts"
    click RefreshS "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/services/auth/refresh.ts"
    click TypesS "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/services/auth/types.ts"
    click RoutesS "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/services/routes/routes.ts"
    click Navbar "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/components/Navbar/Navbar.tsx"
    click NavItem "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/components/Navbar/NavItem.tsx"
    click Modal "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/components/Modal/ModalGenerico.tsx"
    click Tabla "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/components/Tabla/Tabla.tsx"
    click Tarjeta "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/components/TarjetaUsuario.tsx"
    click AuthProv "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/components/Providers/AuthProvider.tsx"
    click GuestR "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/components/Providers/GuestRoute.tsx"
    click ProtectR "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/components/Providers/ProtectRouter.tsx"
    click ThemeProv "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/components/Providers/ThemeProvider.tsx"
    click Btn "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/components/ui/button.tsx"
    click Input "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/components/ui/input.tsx"
    click TableUI "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/components/ui/table.tsx"
    click DataCarr "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/data/carreras.ts"
    click DataInst "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/data/institutos.ts"
    click TypeCarr "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/types/carrera.ts"
    click TypeInst "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/shared/types/instituto.ts"
    click Dev "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/docker-compose.dev.yml"
    click DockerProd "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/docker-compose.yml"
    click Dev "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/eslint.config.js"
    click Dev "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/tree/main/prettierrc"
    click Dev "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/tsconfig.json"
    click Dev "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/index.html"
    click Dev "https://github.com/mapa-de-carreras/mapa-de-carreras-frontend/blob/main/src/index/index.tsx"
```
