Skip to content

README.en.md

Latest commit

 

History

History
71 lines (50 loc) · 2.94 KB

README.en.md

File metadata and controls

71 lines (50 loc) · 2.94 KB
Raw

CLHS Pocket App — The Affiliated Zhongli Senior High School of National Central University

License: MIT Ask DeepWiki

Important

This project is an unofficial third-party service. We are not directly affiliated with CLHS or the ShinHer Smart Campus Platform.

This repository is centered on a native Android app built with Kotlin, Jetpack Compose, and Material 3. It provides grade lookup, analysis, trend comparison, and timetable widgets.

Highlights

  • Native Android app: Built with Kotlin, Jetpack Compose, and Material 3, with direct mobile-side access to the school system.
  • Grade visualization: Radar charts, bar charts, five-standard placement, and score distributions for quickly understanding academic performance.
  • Dark mode and dynamic color: Supports light mode, dark mode, AMOLED pure black mode, and Material You dynamic color.
  • Grade simulator: Adjust subject scores and included subjects to quickly estimate the recalculated average.
  • Historical trend comparison: Automatically compares the current exam with the previous one to track improvement or decline over time.

Architecture Overview

flowchart TB

    %% ===== External Systems =====
    subgraph EXT["External Systems"]
        API["School System API<br/>(shcloud2.k12ea.gov.tw)"]
    end

    %% ===== Data Layer =====
    subgraph DATA["Data Layer (Natural)"]
        CLIENT["SchoolGradeClient<br/>(OkHttp + Jsoup)"]
        REPO["GradeRepository"]
        CACHE["GradeCacheStore<br/>(DataStore)"]

        CLIENT --> REPO
        REPO <--> CACHE
    end

    %% ===== Logic & UI =====
    subgraph UI["Logic & UI (Code Entity Space)"]
        VM["ScoreViewModel"]
        ANALYSIS["GradeAnalysis.kt"]
        SCREEN["Compose UI<br/>(GradesScreen)"]

        VM <--> ANALYSIS
        VM --> SCREEN
    end

    %% ===== Connections =====
    CLIENT <--> |HTTPS/JSON| API
    REPO --> VM
Loading

Project Structure

Directory Description Documentation
android/ Native Kotlin / Jetpack Compose app android/README.md
.github/workflows/ Workflows for Android releases and code scanning

Quick Start

See android/README.md for instructions on building and testing the Android app with Gradle.

Contributor

@alvin000009238

License

MIT © 2026 alvin000009238