https://github.com/atick-faisal/Jetpack-Android-Starter
Starter code for Android Kotlin Project with Jetpack Compose 🚀
https://github.com/atick-faisal/Jetpack-Android-Starter
android clean-architecture convention-plugin gradle-kotlin-dsl hilt-android jetpack-compose kotlin kotlin-coroutines multimodule mvvm okhttp3 retrofit2 template version-catalog
Last synced: 3 months ago
JSON representation
Starter code for Android Kotlin Project with Jetpack Compose 🚀
- Host: GitHub
- URL: https://github.com/atick-faisal/Jetpack-Android-Starter
- Owner: atick-faisal
- License: apache-2.0
- Created: 2021-11-29T18:10:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-01T20:52:59.000Z (3 months ago)
- Last Synced: 2025-03-01T21:25:58.905Z (3 months ago)
- Topics: android, clean-architecture, convention-plugin, gradle-kotlin-dsl, hilt-android, jetpack-compose, kotlin, kotlin-coroutines, multimodule, mvvm, okhttp3, retrofit2, template, version-catalog
- Language: Kotlin
- Homepage: https://play.google.com/store/apps/details?id=dev.atick.compose
- Size: 184 MB
- Stars: 93
- Watchers: 5
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-list - atick-faisal/Jetpack-Android-Starter - Starter code for Android Kotlin Project with Jetpack Compose 🚀 (Kotlin)
README
# 🚀 Jetpack Android Starter
A robust, production-ready template for modern Android development that takes the pain out of
setting up a new project. Built on the foundation
of [Now In Android](https://github.com/android/nowinandroid)'s architecture, this template provides
a comprehensive starting point for both new and experienced Android developers.
## 📱 Apps Built With This Template
Check out apps built with this
template [here](https://github.com/atick-faisal?tab=repositories&q=&type=source&language=kotlin&sort=).
## ☃️ Why This Template?
- **Production-Ready Authentication**: Firebase authentication with Google Sign-In and
email/password
- **Clean Architecture**: Clear separation of concerns with a modular, scalable architecture
- **Modern Tech Stack**: Latest Android development tools including Jetpack Compose
- **Type-Safe Navigation**: Fully typed navigation using Kotlin serialization
- **Robust Data Management**: Repository pattern with Room and DataStore
- **Firebase Integration**: Auth, Firestore, Analytics, and Crashlytics
- **Background Sync**: Data synchronization using WorkManager
- **Multilingual Support**: Runtime localization update with support for RTL languages
- **CI/CD**: Automated build, release, and deployment with GitHub Actions
## 📂 Technical Stack
### 💾 Core Libraries
- **UI**: [Jetpack Compose](https://developer.android.com/compose), [Material3](https://m3.material.io/)
- **DI**: [Dagger Hilt](https://dagger.dev/hilt/)
- **Async**: [Kotlin Coroutines](https://kotlinlang.org/docs/coroutines-overview.html) & [Flow](https://kotlinlang.org/docs/flow.html)
- **Network**: [Retrofit](https://square.github.io/retrofit/), [OkHttp](https://square.github.io/okhttp/)
- **Storage**: [Room DB](https://developer.android.com/training/data-storage/room), [DataStore](https://developer.android.com/topic/libraries/architecture/datastore)
- **Firebase**: [Auth](https://firebase.google.com/docs/auth/android/start), [Firestore](https://firebase.google.com/docs/firestore/quickstart), [Analytics](https://firebase.google.com/docs/analytics), [Performance](https://firebase.google.com/docs/perf-mon)
- **Others**: [WorkManager](https://developer.android.com/topic/libraries/architecture/workmanager), [Coil](https://coil-kt.github.io/coil/), [Timber](https://github.com/JakeWharton/timber), [Lottie](https://airbnb.io/lottie/)
### 🏗️ Build & Tools
- [Kotlin 2.0](https://kotlinlang.org/)
- [Gradle 8.11.1](https://docs.gradle.org/current/userguide/userguide.html) with [Version Catalogs](https://docs.gradle.org/current/userguide/version_catalogs.html)
- [Java 21](https://openjdk.java.net/projects/jdk/21/)
- Custom [Gradle Convention Plugins](https://docs.gradle.org/current/userguide/custom_plugins.html)
- [Dokka](https://kotlinlang.org/docs/dokka-introduction.html) and [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) for documentation
- [ktlint](https://github.com/pinterest/ktlint) and [Spotless](https://github.com/diffplug/spotless) for code formatting
## 📖 Documentation
### [📚 Full Documentation](https://atick.dev/Jetpack-Android-Starter)
### 🎯 Getting Started
- [Quick Start Guide](docs/getting-started.md)
- [Firebase Setup](docs/firebase.md)
- [Dependency Management](docs/dependency.md)
### 🏛️ Architecture & Design
- [Architecture Overview](docs/architecture.md)
- [Design Philosophy](docs/philosophy.md)
- [Adding New Features](docs/guide.md)
### 🚧 Development Tools
- [Convention Plugins](docs/plugins.md)
- [Code Style with Spotless](docs/spotless.md)
- [Performance Optimization](docs/performance.md)
- [Useful Tips & Tricks](docs/tips.md)
### ⚡ Deployment
- [GitHub CI/CD Setup](docs/github.md)
- [Fastlane Configuration](docs/fastlane.md)
### [📚 API Reference](https://atick.dev/Jetpack-Android-Starter/api/)
Qatar University Machine Learning Group
