|
| 1 | +<div align="center"> |
| 2 | + |
| 3 | +<img src="docs/images/graphs/logo.svg" width="120" alt="Logo"/> |
| 4 | + |
| 5 | +# AndroidProject-Compose |
| 6 | + |
| 7 | +_A fast-start Android framework built with Jetpack Compose_ |
| 8 | + |
| 9 | +<!-- Language Switch Button --> |
| 10 | +<div align="center"> |
| 11 | + <a href="README.md">🌍 中文</a> |
| 12 | +</div> |
| 13 | + |
| 14 | +[](https://github.com/Joker-x-dev/AndroidProject-Compose) |
| 15 | +[](https://gitee.com/Joker-x-dev/AndroidProject-Compose) |
| 16 | +[](https://www.pgyer.com/AndroidProject-Compose) |
| 17 | +[](https://compose.dusksnow.top) |
| 18 | +[](https://deepwiki.com/Joker-x-dev/AndroidProject-Compose) |
| 19 | + |
| 20 | +</div> |
| 21 | + |
| 22 | +## 📖 Project Overview |
| 23 | + |
| 24 | +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. |
| 25 | + |
| 26 | +> 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! |
| 27 | +
|
| 28 | +## 📱 Preview |
| 29 | + |
| 30 | +<img src="docs/images/preview/page.png" alt="page"/> |
| 31 | + |
| 32 | +### 📍 Project Links |
| 33 | + |
| 34 | +- **GitHub**: [https://github.com/Joker-x-dev/AndroidProject-Compose](https://github.com/Joker-x-dev/AndroidProject-Compose) |
| 35 | +- **Gitee**: [https://gitee.com/Joker-x-dev/AndroidProject-Compose](https://gitee.com/Joker-x-dev/AndroidProject-Compose) |
| 36 | + |
| 37 | +> 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 |
| 38 | +
|
| 39 | +### Demo Download |
| 40 | + |
| 41 | +**Release build (2MB)**: [Download](https://www.pgyer.com/AndroidProject-Compose) |
| 42 | +- **Supported OS**: Android 6.0 and above |
| 43 | +- **Release notes**: Preview builds update occasionally and may not always reflect the latest code changes |
| 44 | + |
| 45 | +### Documentation |
| 46 | + |
| 47 | +- **Docs**: [View online](https://compose.dusksnow.top) |
| 48 | +- **Note**: Online docs stay in sync with the code and cover quick start, architecture, sample routes, common customization points, and more. |
| 49 | + |
| 50 | +## 🛠️ Tech Stack |
| 51 | + |
| 52 | +### Core Technologies |
| 53 | + |
| 54 | +| Category | Technology | Version | Description | |
| 55 | +|-----------------------|---------------------|------------|------------------------------| |
| 56 | +| Programming Language | Kotlin | 2.2.21 | 100% Kotlin | |
| 57 | +| UI Framework | Jetpack Compose | 2025.11.01 | Declarative UI framework | |
| 58 | +| Dependency Injection | Hilt | 2.57.2 | Dagger-based DI framework | |
| 59 | + |
| 60 | +### Feature Modules |
| 61 | + |
| 62 | +| Category | Technology | Version | Description | |
| 63 | +|------------|------------------------|---------------|---------------------------| |
| 64 | +| Navigation | Navigation Compose | 2.9.6 | Compose navigation | |
| 65 | +| Network | Retrofit + OkHttp | 3.0.0 + 5.3.2 | HTTP client | |
| 66 | + |
| 67 | +### Data Storage |
| 68 | + |
| 69 | +| Category | Technology | Version | Description | |
| 70 | +|---------------|------------|---------|----------------------------------| |
| 71 | +| Database | Room | 2.8.4 | SQLite database | |
| 72 | +| Local Storage | MMKV | 2.2.4 | High-performance key-value store | |
| 73 | + |
| 74 | +### Development Tools |
| 75 | + |
| 76 | +| Category | Technology | Version | Description | |
| 77 | +|-------------------|------------|---------|------------------------| |
| 78 | +| Logging | Timber | 5.0.1 | Log management | |
| 79 | +| Network Debugging | Chucker | 4.2.0 | Network request monitor| |
| 80 | +| Memory Leak Check | LeakCanary | 2.14 | Memory leak detection | |
| 81 | + |
| 82 | +## 📱 Feature Module Directory |
| 83 | + |
| 84 | +- **Main Module (main)** |
| 85 | + - Main page (main) |
| 86 | + - Core capability demos (core-demo) |
| 87 | + - Navigation demos (navigation-demo) |
| 88 | + |
| 89 | +- **Auth Module (auth)** |
| 90 | + - Login (login) |
| 91 | + |
| 92 | +- **User Module (user)** |
| 93 | + - User info (info) |
| 94 | + |
| 95 | +- **Demo Module (demo)** |
| 96 | + - Generic network request demo (network-demo) |
| 97 | + - Generic paged list demo (network-list-demo) |
| 98 | + - Database demo (database) |
| 99 | + - Local storage demo (local-storage) |
| 100 | + - State management demo (state-management) |
| 101 | + - Network request demo (network-request) |
| 102 | + - Navigation with args (navigation-with-args) |
| 103 | + - Navigation result passing (navigation-result) |
| 104 | + |
| 105 | +## Project Structure |
| 106 | + |
| 107 | +``` |
| 108 | +├── app/ # App entry |
| 109 | +├── core/ # Core |
| 110 | +│ ├── base/ # Base abstractions |
| 111 | +│ ├── data/ # Data layer |
| 112 | +│ ├── database/ # Database |
| 113 | +│ ├── datastore/ # Data storage |
| 114 | +│ ├── designsystem/ # Design system |
| 115 | +│ ├── model/ # Data models |
| 116 | +│ ├── network/ # Network layer |
| 117 | +│ ├── result/ # Result handling |
| 118 | +│ ├── state/ # State management |
| 119 | +│ ├── ui/ # UI components |
| 120 | +│ └── util/ # Utilities |
| 121 | +├── navigation/ # Navigation module |
| 122 | +│ ├── routes/ # Route definitions |
| 123 | +│ ├── results/ # Route results |
| 124 | +│ └── extension/ # Navigation extensions |
| 125 | +├── feature/ # Feature modules |
| 126 | +│ ├── main/ # Main module |
| 127 | +│ ├── auth/ # Auth module |
| 128 | +│ ├── user/ # User module |
| 129 | +│ └── demo/ # Demo module |
| 130 | +└── MainActivityViewModel.kt # Host-level shared ViewModel |
| 131 | +``` |
| 132 | + |
| 133 | +## 👥 Join the Community |
| 134 | + |
| 135 | +Welcome to the developer group—share learning notes and discuss technical questions together! |
| 136 | + |
| 137 | +<div align="left"> |
| 138 | + <img src="docs/images/group/qq.jpg" width="200" alt="QQ group QR code"/> |
| 139 | + <p>Scan or search the group number to join the QQ group</p> |
| 140 | +</div> |
| 141 | + |
| 142 | +## 🤝 Contributing |
| 143 | + |
| 144 | +This is an open learning project. All Android enthusiasts are welcome to contribute! |
| 145 | + |
| 146 | +### 🎯 How to Contribute |
| 147 | + |
| 148 | +- **Code Contributions**: Submit pull requests to improve features or fix issues |
| 149 | +- **Issue Feedback**: Report bugs or suggest features via Issues |
| 150 | +- **Documentation**: Enhance docs, add usage guides or developer guides |
| 151 | +- **Design Support**: Provide UI/UX suggestions or assets |
| 152 | +- **Testing Help**: Join feature testing and share feedback |
| 153 | + |
| 154 | +### 📋 Contribution Guidelines |
| 155 | + |
| 156 | +- Please follow the project coding conventions before submitting code |
| 157 | +- For new features, create an Issue first to discuss feasibility |
| 158 | +- Sharing learning notes and technical takeaways is encouraged |
0 commit comments