# swent-roamigo/roamigo architecture

> Architecture diagram of the GitHub repository swent-roamigo/roamigo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/swent-roamigo/roamigo
- Repository: https://github.com/swent-roamigo/roamigo

## Overview

Roamigo is an Android group-travel planning app. Users sign in, create a trip with destinations and dates, invite friends, collaboratively maintain an itinerary, and vote on activities; during travel they share live locations and geotagged photos on maps, with cached plans and queued changes for offline use. The graph separates UI, trip collaboration, integrations, and supporting capabilities. README statements establish the broad feature relationships; source-index references and excerpts support only selected internal calls, so uncertain wiring is omitted or dashed.

Main entry points: [`app/src/main/java/com/swent/roamigo/ui/trip/creation/CreateTripViewModel.kt`](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/trip/creation/CreateTripViewModel.kt) (Trip creation), [`app/src/main/java/com/swent/roamigo/ui/map/TripMapViewModel.kt`](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/map/TripMapViewModel.kt) (Location map), [`app/src/main/java/com/swent/roamigo/ui/photos/PhotosViewModel.kt`](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/photos/PhotosViewModel.kt) (Trip photos), [`app/src/main/java/com/swent/roamigo/ui/trip/TripScreen.kt`](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/trip/TripScreen.kt) (Trip screens)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Android app"]
  node_entry["App entry<br/>[MainActivity.kt]"]
  node_application["App shell<br/>[RoamigoApp.kt]"]
  node_authui["Sign-in UI"]
  node_authvm["Auth state"]
  node_tripui["Trip screens<br/>[TripScreen.kt]"]
  node_votingui["Voting screens<br/>[VoteViewModel.kt]"]
  node_locationui["Location map"]
  node_photosui["Trip photos<br/>[PhotosViewModel.kt]"]
  node_history["Trip history"]
  node_heatmap["Explored countries"]
end

subgraph group_planning["Trip planning"]
  node_tripcreate["Trip creation"]
  node_destination["Destination search"]
  node_places["Place search"]
  node_trips[("Trip records")]
  node_activities[("Itinerary activities")]
end

subgraph group_collaboration["Group collaboration"]
  node_friends[("Friend network")]
  node_votes[("Vote data")]
end

subgraph group_travel["Travel experience"]
  node_location["Location sharing"]
  node_photos["Photo sync"]
  node_map{{"Interactive map"}}
  node_country["Country tracking"]
end

subgraph group_backend["Backend services"]
  node_authrepo["Firebase auth"]
  node_invitations["Trip invitations<br/>[tripInvitations.ts]"]
  node_resolution["Vote resolution"]
  node_functions["Vote functions<br/>[voteResolution.ts]"]
end

node_traveler(("Traveler"))
node_firebaseauth{{"Firebase Authentication"}}
node_realtime[("Realtime Database")]
node_storage[("Firebase Storage")]

node_traveler -.->|"opens"| node_entry
node_entry -.->|"launches"| node_application
node_application -.->|"presents"| node_authui
node_authui -.->|"submits credentials"| node_authvm
node_authvm -.->|"authenticates"| node_authrepo
node_authrepo -->|"signs in"| node_firebaseauth
node_traveler -.->|"plans trip"| node_tripcreate
node_tripcreate -.->|"searches destinations"| node_destination
node_tripcreate -.->|"creates trip"| node_trips
node_tripcreate -.->|"suggests places"| node_places
node_tripui -.->|"reads itinerary"| node_trips
node_tripui -.->|"edits activities"| node_activities
node_traveler -.->|"manages friends"| node_friends
node_traveler -->|"invites members"| node_invitations
node_traveler -.->|"casts votes"| node_votingui
node_votingui -.->|"submits ballots"| node_votes
node_resolution -->|"calls functions"| node_functions
node_traveler -->|"views group map"| node_locationui
node_locationui -.->|"shares positions"| node_location
node_location -->|"publishes locations"| node_realtime
node_traveler -->|"shares photos"| node_photosui
node_photosui -.->|"queues photos"| node_photos
node_photos -->|"uploads photos"| node_storage
node_locationui -->|"renders locations"| node_map
node_photosui -->|"shows geotagged photos"| node_map
node_traveler -.->|"reviews trips"| node_history
node_history -.->|"opens exploration map"| node_heatmap
node_heatmap -.->|"tracks countries"| node_country

click node_entry "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/MainActivity.kt"
click node_application "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/RoamigoApp.kt"
click node_authui "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/authentication/AuthenticationScreen.kt"
click node_authvm "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/authentication/AuthenticationViewModel.kt"
click node_authrepo "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/authentication/AuthRepositoryFirebase.kt"
click node_tripcreate "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/trip/creation/CreateTripViewModel.kt"
click node_destination "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/destination/OnlineDestinationRepository.kt"
click node_places "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/place/MapboxPlaceRepository.kt"
click node_trips "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/trip/TripRepositoryFirestore.kt"
click node_activities "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/trip/activity/ActivityRepositoryFirestore.kt"
click node_tripui "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/trip/TripScreen.kt"
click node_friends "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/friends/FriendRepositoryFirestore.kt"
click node_invitations "https://github.com/swent-roamigo/roamigo/blob/main/functions/src/tripInvitations.ts"
click node_votingui "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/trip/voting/VoteViewModel.kt"
click node_votes "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/trip/voting/VoteRepositoryFirestore.kt"
click node_resolution "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/trip/voting/VoteResolutionService.kt"
click node_functions "https://github.com/swent-roamigo/roamigo/blob/main/functions/src/voteResolution.ts"
click node_locationui "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/map/TripMapViewModel.kt"
click node_location "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/location/DefaultLocationRepository.kt"
click node_photosui "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/photos/PhotosViewModel.kt"
click node_photos "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/photo/DefaultPhotoRepository.kt"
click node_history "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/trip/history/TripHistoryViewModel.kt"
click node_heatmap "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/heatmap/TravelHeatmapViewModel.kt"
click node_country "https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/country/VisitedCountryRepository.kt"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_entry,node_application,node_authui,node_authvm,node_tripui,node_votingui,node_locationui,node_photosui,node_history,node_heatmap toneBlue
class node_tripcreate,node_destination,node_places,node_trips,node_activities,node_realtime,node_storage toneAmber
class node_friends,node_votes toneMint
class node_location,node_photos,node_map,node_country toneRose
class node_authrepo,node_invitations,node_resolution,node_functions,node_traveler,node_firebaseauth toneIndigo
```

## Components

### Android app

- [App entry](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/MainActivity.kt): `app/src/main/java/com/swent/roamigo/MainActivity.kt`
- [App shell](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/RoamigoApp.kt): `app/src/main/java/com/swent/roamigo/ui/RoamigoApp.kt`
- [Sign-in UI](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/authentication/AuthenticationScreen.kt): `app/src/main/java/com/swent/roamigo/ui/authentication/AuthenticationScreen.kt`
- [Auth state](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/authentication/AuthenticationViewModel.kt): `app/src/main/java/com/swent/roamigo/ui/authentication/AuthenticationViewModel.kt`
- [Trip screens](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/trip/TripScreen.kt): `app/src/main/java/com/swent/roamigo/ui/trip/TripScreen.kt`
- [Voting screens](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/trip/voting/VoteViewModel.kt): `app/src/main/java/com/swent/roamigo/ui/trip/voting/VoteViewModel.kt`
- [Location map](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/map/TripMapViewModel.kt): `app/src/main/java/com/swent/roamigo/ui/map/TripMapViewModel.kt`
- [Trip photos](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/photos/PhotosViewModel.kt): `app/src/main/java/com/swent/roamigo/ui/photos/PhotosViewModel.kt`
- [Trip history](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/trip/history/TripHistoryViewModel.kt): `app/src/main/java/com/swent/roamigo/ui/trip/history/TripHistoryViewModel.kt`
- [Explored countries](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/heatmap/TravelHeatmapViewModel.kt): `app/src/main/java/com/swent/roamigo/ui/heatmap/TravelHeatmapViewModel.kt`

### Trip planning

- [Trip creation](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/ui/trip/creation/CreateTripViewModel.kt): `app/src/main/java/com/swent/roamigo/ui/trip/creation/CreateTripViewModel.kt`
- [Destination search](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/destination/OnlineDestinationRepository.kt): `app/src/main/java/com/swent/roamigo/model/destination/OnlineDestinationRepository.kt`
- [Place search](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/place/MapboxPlaceRepository.kt): `app/src/main/java/com/swent/roamigo/model/place/MapboxPlaceRepository.kt`
- [Trip records](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/trip/TripRepositoryFirestore.kt): `app/src/main/java/com/swent/roamigo/model/trip/TripRepositoryFirestore.kt`
- [Itinerary activities](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/trip/activity/ActivityRepositoryFirestore.kt): `app/src/main/java/com/swent/roamigo/model/trip/activity/ActivityRepositoryFirestore.kt`

### Group collaboration

- [Friend network](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/friends/FriendRepositoryFirestore.kt): `app/src/main/java/com/swent/roamigo/model/friends/FriendRepositoryFirestore.kt`
- [Vote data](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/trip/voting/VoteRepositoryFirestore.kt): `app/src/main/java/com/swent/roamigo/model/trip/voting/VoteRepositoryFirestore.kt`

### Travel experience

- [Location sharing](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/location/DefaultLocationRepository.kt): `app/src/main/java/com/swent/roamigo/model/location/DefaultLocationRepository.kt`
- [Photo sync](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/photo/DefaultPhotoRepository.kt): `app/src/main/java/com/swent/roamigo/model/photo/DefaultPhotoRepository.kt`
- **Interactive map**
- [Country tracking](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/country/VisitedCountryRepository.kt): `app/src/main/java/com/swent/roamigo/model/country/VisitedCountryRepository.kt`

### Backend services

- [Firebase auth](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/authentication/AuthRepositoryFirebase.kt): `app/src/main/java/com/swent/roamigo/model/authentication/AuthRepositoryFirebase.kt`
- [Trip invitations](https://github.com/swent-roamigo/roamigo/blob/main/functions/src/tripInvitations.ts): `functions/src/tripInvitations.ts`
- [Vote resolution](https://github.com/swent-roamigo/roamigo/blob/main/app/src/main/java/com/swent/roamigo/model/trip/voting/VoteResolutionService.kt): `app/src/main/java/com/swent/roamigo/model/trip/voting/VoteResolutionService.kt`
- [Vote functions](https://github.com/swent-roamigo/roamigo/blob/main/functions/src/voteResolution.ts): `functions/src/voteResolution.ts`

### Other components

- **Traveler**
- **Firebase Authentication**
- **Realtime Database**
- **Firebase Storage**

## Connections

- Traveler → App entry: opens
- App entry → App shell: launches (evidence: `app/src/main/java/com/swent/roamigo/MainActivity.kt`)
- App shell → Sign-in UI: presents
- Sign-in UI → Auth state: submits credentials
- Auth state → Firebase auth: authenticates
- Firebase auth → Firebase Authentication: signs in (evidence: `app/src/main/java/com/swent/roamigo/model/authentication/AuthRepositoryFirebase.kt`)
- Traveler → Trip creation: plans trip
- Trip creation → Destination search: searches destinations
- Trip creation → Trip records: creates trip
- Trip creation → Place search: suggests places
- Trip screens → Trip records: reads itinerary
- Trip screens → Itinerary activities: edits activities
- Traveler → Friend network: manages friends
- Traveler → Trip invitations: invites members (evidence: `README.md`)
- Traveler → Voting screens: casts votes
- Voting screens → Vote data: submits ballots
- Vote resolution → Vote functions: calls functions (evidence: `app/src/main/java/com/swent/roamigo/model/trip/voting/VoteResolutionService.kt`)
- Traveler → Location map: views group map (evidence: `README.md`)
- Location map → Location sharing: shares positions
- Location sharing → Realtime Database: publishes locations (evidence: `app/src/main/java/com/swent/roamigo/model/location/DefaultLocationRepository.kt`)
- Traveler → Trip photos: shares photos (evidence: `README.md`)
- Trip photos → Photo sync: queues photos
- Photo sync → Firebase Storage: uploads photos (evidence: `README.md`)
- Location map → Interactive map: renders locations (evidence: `README.md`)
- Trip photos → Interactive map: shows geotagged photos (evidence: `README.md`)
- Traveler → Trip history: reviews trips
- Trip history → Explored countries: opens exploration map
- Explored countries → Country tracking: tracks countries
