English | 简体中文
SunnyBeach Android
SunnyBeach is an unofficial/community open-source Android client developed based on the SunnyBeach Community Open API. The project adheres to the Kotlin First principle and follows Modern Android Architecture best practices.
Architecture & Tech Stack
This project adopts a modular engineering design with the classic MVVM architecture.
Project Structure
:app - Main application entry point and host business layer.:library - Collection of common capability modules (not a single module), including several submodules:
:library:base - Base class encapsulation (BaseActivity / Fragment / Adapter, etc.).:library:widget - Custom UI controls and components.:library:network - Network layer.:library:umeng - Umeng integration.
build-logic - (included build) Unified build logic and plugin management, with the convention subproject storing Gradle convention plugins and ProjectConfig.kt.tools - Project auxiliary tools isolated by purpose (such as emoji resource processing and course video playback link extraction tools).
Tech Stack
- Language: Kotlin (100% Kotlin First)
- Architecture Components: Google Jetpack (ViewModel, LiveData, etc.)
- UI / Base Components: BRVAH (list adapter), XXPermissions (permission management), AndroidUtilCode
- Networking: Retrofit, OkHttp, EasyHttp
- Persistence: Room
- Image Loading: Glide
- Integrated Services: UmengSDK (Umeng Analytics)
Building & Development
1. Requirements
- JDK 21+ (The project enforces version validation in
settings.gradle.kts; builds will fail with versions below 21).
- Latest stable version of Android Studio is recommended.
- After cloning the repository, switch the IDE view to Project mode.
2. Configuration (Required Signing and Keys)
To ensure successful compilation and core service operation, you need to configure the signing file and third-party credentials.
Create/modify the configuration files in the project root directory:
After configuration, click Sync Now to compile and run :app.
Screenshots & Download
Pre-release/test version download options:
For complete application interface screenshots, please refer to SCREENSHOTS.md.
For the story behind SunnyBeach’s founding, mission and vision, and author appreciation information, please read 👉 ABOUT.md.
License
Copyright 2021 He XiaoFeng (anjiemo)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
评论