Logo # AndroidProject-Compose _A fast-start Android framework built with Jetpack Compose_
🌍 δΈ­ζ–‡
[![GitHub](https://img.shields.io/badge/GitHub-AndroidProjectCompose-blue?style=flat-square&logo=github)](https://github.com/Joker-x-dev/AndroidProject-Compose) [![Gitee](https://img.shields.io/badge/Gitee-AndroidProjectCompose-red?style=flat-square&logo=gitee)](https://gitee.com/Joker-x-dev/AndroidProject-Compose) [![Demo](https://img.shields.io/badge/Demo-Download-green?style=flat-square&logo=android)](https://www.pgyer.com/AndroidProject-Compose) [![API](https://img.shields.io/badge/Docs-compose.dusksnow.top-orange?style=flat-square&logo=readthedocs)](https://compose.dusksnow.top) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Joker-x-dev/AndroidProject-Compose)
## πŸ“– Project Overview AndroidProject-Compose is a **single-module Jetpack Compose scaffold** that ships with the essential building blocks for networking, state, navigation, theming, data storage, and database access. It also includes a few feature demo pages so you can β€œclone β†’ run β†’ plug in your business logic” to quickly build or learn a modern Compose app. > If this project helps you, please give it a Star ⭐ It means a lot and keeps me motivated to maintain and update the project long-term! ## πŸ“± Preview page ### πŸ“ Project Links - **GitHub**: [https://github.com/Joker-x-dev/AndroidProject-Compose](https://github.com/Joker-x-dev/AndroidProject-Compose) - **Gitee**: [https://gitee.com/Joker-x-dev/AndroidProject-Compose](https://gitee.com/Joker-x-dev/AndroidProject-Compose) > This scaffold originates from the CoolMall practice project and keeps only the foundational capabilities plus sample pages. For the full e-commerce business, complete UI/animations, and full-featured demos, see CoolMall: GitHub https://github.com/Joker-x-dev/CoolMallKotlin ｜ Gitee https://gitee.com/Joker-x-dev/CoolMallKotlin ### Demo Download **Release build (2MB)**: [Download](https://www.pgyer.com/AndroidProject-Compose) - **Supported OS**: Android 6.0 and above - **Release notes**: Preview builds update occasionally and may not always reflect the latest code changes ### Documentation - **Docs**: [View online](https://compose.dusksnow.top) - **Note**: Online docs stay in sync with the code and cover quick start, architecture, sample routes, common customization points, and more. ## πŸ› οΈ Tech Stack ### Core Technologies | Category | Technology | Version | Description | |-----------------------|---------------------|------------|------------------------------| | Programming Language | Kotlin | 2.2.21 | 100% Kotlin | | UI Framework | Jetpack Compose | 2025.11.01 | Declarative UI framework | | Dependency Injection | Hilt | 2.57.2 | Dagger-based DI framework | ### Feature Modules | Category | Technology | Version | Description | |------------|------------------------|---------------|---------------------------| | Navigation | Navigation Compose | 2.9.6 | Compose navigation | | Network | Retrofit + OkHttp | 3.0.0 + 5.3.2 | HTTP client | ### Data Storage | Category | Technology | Version | Description | |---------------|------------|---------|----------------------------------| | Database | Room | 2.8.4 | SQLite database | | Local Storage | MMKV | 2.2.4 | High-performance key-value store | ### Development Tools | Category | Technology | Version | Description | |-------------------|------------|---------|------------------------| | Logging | Timber | 5.0.1 | Log management | | Network Debugging | Chucker | 4.2.0 | Network request monitor| | Memory Leak Check | LeakCanary | 2.14 | Memory leak detection | ## πŸ“± Feature Module Directory - **Main Module (main)** - Main page (main) - Core capability demos (core-demo) - Navigation demos (navigation-demo) - **Auth Module (auth)** - Login (login) - **User Module (user)** - User info (info) - **Demo Module (demo)** - Generic network request demo (network-demo) - Generic paged list demo (network-list-demo) - Database demo (database) - Local storage demo (local-storage) - State management demo (state-management) - Network request demo (network-request) - Navigation with args (navigation-with-args) - Navigation result passing (navigation-result) ## Project Structure ``` β”œβ”€β”€ app/ # App entry β”œβ”€β”€ core/ # Core β”‚ β”œβ”€β”€ base/ # Base abstractions β”‚ β”œβ”€β”€ data/ # Data layer β”‚ β”œβ”€β”€ database/ # Database β”‚ β”œβ”€β”€ datastore/ # Data storage β”‚ β”œβ”€β”€ designsystem/ # Design system β”‚ β”œβ”€β”€ model/ # Data models β”‚ β”œβ”€β”€ network/ # Network layer β”‚ β”œβ”€β”€ result/ # Result handling β”‚ β”œβ”€β”€ state/ # State management β”‚ β”œβ”€β”€ ui/ # UI components β”‚ └── util/ # Utilities β”œβ”€β”€ navigation/ # Navigation module β”‚ β”œβ”€β”€ routes/ # Route definitions β”‚ β”œβ”€β”€ results/ # Route results β”‚ └── extension/ # Navigation extensions β”œβ”€β”€ feature/ # Feature modules β”‚ β”œβ”€β”€ main/ # Main module β”‚ β”œβ”€β”€ auth/ # Auth module β”‚ β”œβ”€β”€ user/ # User module β”‚ └── demo/ # Demo module └── MainActivityViewModel.kt # Host-level shared ViewModel ``` ## πŸ‘₯ Join the Community Welcome to the developer groupβ€”share learning notes and discuss technical questions together!
QQ group QR code

Scan or search the group number to join the QQ group

## 🀝 Contributing This is an open learning project. All Android enthusiasts are welcome to contribute! ### 🎯 How to Contribute - **Code Contributions**: Submit pull requests to improve features or fix issues - **Issue Feedback**: Report bugs or suggest features via Issues - **Documentation**: Enhance docs, add usage guides or developer guides - **Design Support**: Provide UI/UX suggestions or assets - **Testing Help**: Join feature testing and share feedback ### πŸ“‹ Contribution Guidelines - Please follow the project coding conventions before submitting code - For new features, create an Issue first to discuss feasibility - Sharing learning notes and technical takeaways is encouraged