Leechai

Download on the App Store

🔍 Overview

Architecture

flowchart LR
    subgraph Mobile["📱 Mobile Client"]
        direction TB
        App["Flutter App"]
        LocalDB[("SQLite<br/>(Local DB)")]
        SyncService["Cloud Sync Service"]

        App <-->|Read / Write| LocalDB
        App --> SyncService
        SyncService <-->|Fetch / Update| LocalDB
    end

    Internet(("🌐 Internet"))

    subgraph Backend["☁️ Backend Services"]
        direction TB
        Proxy["Nginx<br/>(Reverse Proxy)"]
        API["FastAPI Server"]
        Cache[("Redis<br/>(In-Memory Cache)")]
        DB[("PostgreSQL<br/>(Relational DB)")]

        Proxy <--> API
        API <--> Cache
        API <--> DB
    end

    subgraph GitHubPages["📄 GitHub Pages"]
        direction TB
        StaticSite["Static Site<br/>(Privacy, ToS, Licenses)"]
    end

    SyncService <-->|Sync API| Internet
    Internet <--> Proxy

Loading

Branches

%%{init: { 'theme': 'base', 'gitGraph': {'showCommitLabel': false}} }%%
gitGraph
   commit
   commit
   branch feature/xxx
   switch feature/xxx
   commit
   commit
   switch main
   merge feature/xxx
   commit
   branch fix/xxx
   switch fix/xxx
   commit
   commit
   switch main
   merge fix/xxx
   commit

Loading

Tech Stack

• Mobile App
  • Programming Language: Dart
  • Framework: Flutter
• API Server
  • Programming Language: Python
  • Framework: FastAPI
• Database: PostgreSQL
• Reverse Proxy: Nginx

🧑🏻‍💻 Development

Quick Start

1. Backend: Follow apiserver/README.md.
2. Mobile: Follow mobile/README.md.

Development Workflow

1. Create a branch from main (feature/xxx or fix/xxx).
2. Commit and push, then open a PR on GitHub.
3. After approval, merge into main.