How aturtle4/flashfeed works
Project type and purpose
• FlashFeed is a full-stack news-aggregator system consisting of:
– An Android client (Jetpack Compose + MVVM + Room)
– A Python backend API (simple service providing /news/fetch)
– External news‐source integrations (e.g., Inshorts or other providers)
• The client delivers personalized, vertical-reel “TikTok-style” news in multiple languages; the backend fetches and normalizes news from upstream sources.
File structure
– Top-level:
• app/… → Android application module using Gradle/Kotlin
• backend/flashfeed-api/app/… → Python service code + requirements.txt
• build.gradle.kts, settings.gradle.kts → multi-module Gradle project
– Android app:
• src/main/java/com/example/flashfeed/API → Retrofit or HTTP client wrappers
• view layers: Home, Explore, Profile, Misc, reel_mechanism, topBar, ui/theme
• ViewModels under Profile and NewsReelViewModel
• Local Room database under database/ (Entities + DAOs)
• Activities: MainActivity, WebViewActivity, SplashActivity
– Backend:
• main.py – server entrypoint (Flask/FastAPI/Starlette)
• news.py, data.py, inshorts.py – fetch & transform logic for each upstream source
README for additional insights
– Architecture: explicitly MVVM on Android
– Lists key entities (UserPreferencesEntity, CategoryEntity, SavedReelEntity)
– Describes adaptive loading, TTS, WebView, multi-language
Elements
• Blue rectangles for Android components
• Green rectangles for backend components
• Clouds for external services
Detail
– Capture every module/folder as a distinct component (API client, DAOs, Entities, modules in backend)
– Label relationships (e.g., “writes to”, “reads from”, “invokes HTTP GET”)