# 1loro/tellevo architecture

> Architecture diagram of the GitHub repository 1loro/tellevo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/1loro/tellevo
- Repository: https://github.com/1loro/tellevo

## Overview

##### Project Type & Purpose
- It’s a full-stack application targeted for mobile devices and web presentation.
- The primary purpose is to enable students to register, request, and manage shared rides.
- Although the README mentions Django REST Framework for the API, the struck‐through text and emphasis on Ionic Angular and Firebase indicate that the core functional stack leverages a mobile frontend (Ionic Angular) with Firebase handling authentication, real-time databases (Firestore), and cloud functions. Additionally, a simple HTML/CSS/JS website functions as the public download/presentation portal.

##### Analyzing the File Structure
- The file tree shows a set of static files including:
- HTML pages (index.html and about.html) – likely representing a landing or download page.
- app.js and style.css – providing client-side functionality and styling.
- Media assets (images and audio files such as gaspi.jfif, loro.jfif, kanguro.mp3, and panda.mp3) that are probably used in the app’s marketing material or for UI elements.
- tellevo.apk – the packaged mobile application file.
- README.md – project documentation.
- There are no explicit directories for backend code in the given tree, so it appears this subset is focused on client-side resources and the mobile app package.

##### Components
a. Mobile Frontend:
- Mention that this layer handles user interactions, ride management, and integrates with authentication and real-time services.
b. Web Presentation Layer:
- A component for the “Website/Download Portal” composed of HTML, CSS, and JavaScript (files like index.html, about.html, app.js, style.css).
- Purpose is to provide information about the app and enable APK download.
c. Backend Services (Firebase):
- Authentication: managing user logins and registrations.
- Firestore: a real-time database to store rides, users, and travel data.
- Cloud Functions: for business logic such as notifications or ride matching.
d. Optional / Historical Component:
e. External Integrations:
- Integration with YouTube for promotional videos (directly linked from the website).
- Mention GitHub Pages as the hosting solution for the public-facing web content.

##### Relationships and Data Flow
- Web portal’s connection to Firebase for displaying dynamic data (if applicable) or simply as a static site for app promotion.

##### Architectural Patterns & Design Principles
- Separation of concerns: the mobile app manages client logic, Firebase centralizes backend data and processing, and the web layer addresses user acquisition.
- That the design follows modern cloud-based architecture principles, leveraging platform services (Firebase) for scalability and reliability versus a traditional monolithic backend.
- Client interfaces (Ionic Mobile App, Web Portal)
- Backend services (Firebase components, and optionally Django API)
- External services (YouTube, GitHub Pages)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend"
        MA["Ionic Angular Mobile App"]:::frontend
        WP["Website/Download Portal"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend Services"
        subgraph "Firebase Platform"
            FA["Authentication (Firebase)"]:::firebase
            FS["Database (Firestore)"]:::firebase
            FC["Cloud Functions (Firebase)"]:::firebase
        end
        API["Django API (Legacy/Planned)"]:::legacy
    end

    %% External Services Layer
    subgraph "External Services"
        YT["YouTube Integration"]:::external
        GP["GitHub Pages"]:::external
    end

    %% Connections from Frontend to Backend
    MA -->|"auth"| FA
    MA -->|"data"| FS
    MA -->|"logic"| FC
    MA -->|"optional"| API

    WP -->|"data-display"| FS
    WP -->|"promo"| YT
    WP -->|"hosted-on"| GP

    %% Styling nodes vertically
    FA --> FS
    FS --> FC

    %% Click Events for Component Mapping
    click MA "https://github.com/1loro/tellevo/blob/main/tellevo.apk"
    click WP "https://github.com/1loro/tellevo/blob/main/index.html"

    %% Styles
    classDef frontend fill:#AED6F1,stroke:#1B4F72,stroke-width:2px
    classDef firebase fill:#F9E79F,stroke:#B9770E,stroke-width:2px
    classDef legacy fill:#F5B7B1,stroke:#922B21,stroke-width:2px
    classDef external fill:#A9DFBF,stroke:#186A3B,stroke-width:2px
```
