Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atick-faisal/Jetpack-Compose-Starter
Starter code for Android Kotlin Project with Jetpack Compose 🚀🚀🚀
https://github.com/atick-faisal/Jetpack-Compose-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: 9 days ago
JSON representation
Starter code for Android Kotlin Project with Jetpack Compose 🚀🚀🚀
- Host: GitHub
- URL: https://github.com/atick-faisal/Jetpack-Compose-Starter
- Owner: atick-faisal
- License: apache-2.0
- Created: 2021-11-29T18:10:46.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T01:45:18.000Z (7 months ago)
- Last Synced: 2024-04-13T18:07:46.318Z (7 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://atick.dev/Jetpack-Compose-Starter/
- Size: 73.8 MB
- Stars: 9
- Watchers: 3
- Forks: 5
- Open Issues: 7
-
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-Compose-Starter - Starter code for Android Kotlin Project with Jetpack Compose 🚀🚀🚀 (Kotlin)
README
## What is it
It's a starting template that I use for all my Android apps. It is based on the architecture of the [Now In Android](https://github.com/android/nowinandroid) app by Google. Check out the app from the latest [Release](https://github.com/atick-faisal/Jetpack-Compose-Starter/releases).
> [!WARNING]
> Firebase authentication and crashlytics requires Firebase console setup and the `google-services.json` file. I have provided a template to ensure a successful build. However, you need to provide your own in order to use all the functionalities.
## Documentation
## Features
This template offers Modern Android Development principles and Architecture guidelines. It provides an out-of-the-box template for:
- Connecting to a remote API using Retrofit and OKHttp
- Persistent database solution using Room and Datastore
- Sign In Authentication using Firebase i.e. Google ID and Email
- Bluetooth communication using classic and low-energy (upcoming) protocols
> [!NOTE]
> Firebase auth needs [setting up](https://developers.google.com/android/guides/client-auth?sjid=11391664450238405928-EU) first using the SHA fingerprint. Get the SHA fingerprint of the app and add it to firebase console.
It contains easy-to-use Interfaces for common tasks. For example, the following provides utilities for Bluetooth communication:
```kotlin
/**
* BluetoothManager interface provides methods to manage Bluetooth connections.
*/
interface BluetoothManager {
/**
* Attempts to establish a Bluetooth connection with the specified device address.
*
* @param address The address of the Bluetooth device to connect to.
* @return A [Result] indicating the success or failure of the connection attempt.
*/
suspend fun connect(address: String): Result
/**
* Returns the state of the connected Bluetooth device.
*
* @return A [StateFlow] emitting the current state of the connected Bluetooth device.
*/
fun getConnectedDeviceState(): StateFlow
/**
* Closes the existing Bluetooth connection.
*
* @return A [Result] indicating the success or failure of closing the connection.
*/
suspend fun closeConnection(): Result
}
```
It also contains several utilities and extension functions to make repetitive tasks easier. For example:
```kotlin
/**
* Displays a short toast message.
*
* @param message The message to be displayed in the toast.
*/
fun Context.showToast(message: String) {
Toast.makeText(this, message, Toast.LENGTH_SHORT).show()
}
/**
* Checks if the app has a given permission.
*
* @param permission The permission to check.
* @return `true` if the permission is granted, `false` otherwise.
*/
fun Context.hasPermission(permission: String): Boolean {
return ContextCompat.checkSelfPermission(this, permission) ==
PackageManager.PERMISSION_GRANTED
}
/**
* Checks if all the given permissions are granted.
*
* @param permissions List of permissions to check.
* @return `true` if all permissions are granted, `false` otherwise.
*/
fun Context.isAllPermissionsGranted(permissions: List): Boolean {
return permissions.all { hasPermission(it) }
}
```
## Technologies
- Kotlin 2.0
- Jetpack Compose
- Kotlin Coroutines
- Kotlin Flow for Reactive Data
- Retrofit and OkHttp
- Firebase Auth
- Firebase Crashlytics
- Room Database
- Preferences Datastore
- Dependency Injection with Hilt
- Gradle Kotlin DSL
- Gradle Version Catalog
- Convention Plugin
## Architecture
This template follows the [official architecture guidance](https://developer.android.com/topic/architecture) suggested by Google.
## Modularization
## Building
### Debug
This project requires Firebase for analytics. Building the app requires `google-services.json` to be present inside the `app` dir. This file can be generated from the [Firebase Console](https://firebase.google.com/docs/android/setup). After that, run the following from the terminal.
```sh
$ ./gradlew assembleDebug
```
Or, use `Build > Rebuild Project`.
### Release
Building the `release` version requires a `Keystore` file in the `app` dir. Also, a `keystore.properties` file needs to be created in the `rootDir`.
```
storePassword=****
keyPassword=*****
keyAlias=****
storeFile=keystore file name (e.g., key.jks)
```
After that, run the following from the terminal.
```sh
$ ./gradlew assembleRelease
```
Qatar University Machine Learning Group
