https://github.com/hossain-khan/android-compose-app-template

An Android App template that is preconfigured with Circuit UDF architecture.
https://github.com/hossain-khan/android-compose-app-template

android-architecture android-circuit android-template circuit compose jetpack-compose udf

Last synced: 23 days ago
JSON representation

An Android App template that is preconfigured with Circuit UDF architecture.

• Host: GitHub
• URL: https://github.com/hossain-khan/android-compose-app-template
• Owner: hossain-khan
• License: mit
• Created: 2024-11-09T17:30:57.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-12-27T14:11:49.000Z (about 1 month ago)
• Last Synced: 2025-01-08T09:45:55.662Z (about 1 month ago)
• Topics: android-architecture, android-circuit, android-template, circuit, compose, jetpack-compose, udf
• Language: Kotlin
• Homepage:
• Size: 191 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Android - Circuit App Template

An Android App template that is preconfigured with Circuit UDF architecture.

> [!TIP]

> Google has an official template available. Have you checked it out yet?  

> https://github.com/android/architecture-templates

## What do you get in this template? 📜

* ✔️ [Circuit](https://github.com/slackhq/circuit) library setup for the app

* ✔️ Dependency Injection for all Circuit Screens & Presenter combo

* ✔️ GitHub Actions for CI

* ✔️ [Google font](https://github.com/hossain-khan/android-compose-app-template/blob/main/app/src/main/java/app/example/ui/theme/Type.kt#L9-L14) for choosing different app font.

* ✔️ `BuildConfig` turned on with example of reading config from `local.properties` file.

> [!WARNING]  

> _This template is only for Android app setup. If you are looking for a multi-platform supported template,_

> _look at the official [Circuit](https://github.com/slackhq/circuit) example apps included in the repository._

### Post-process after cloning 🧑‍🏭

Unfortunately, you do have to do some manual work after using the template, namely:

* [ ] Rename the package from **`app.example`** to your preferred app package name.

* [ ] Update directory structure based on package name update

* [ ] Update app name and package id in XML and Gradle

* [ ] Update your app theme colors (_use [Theme Builder](https://material-foundation.github.io/material-theme-builder/)_)

* [ ] Generate your app icon (_use [Icon Kitchen](https://icon.kitchen/)_)

* [ ] Rename `ComposeApp***` to preferred file names

* [ ] Remove `Example***` files that were added to showcase example usage of app and Circuit.

* [ ] Update/remove repository license

* [ ] Configure [renovate](https://github.com/apps/renovate) for depenency management or remove [`renovate.json`](https://github.com/hossain-khan/android-compose-app-template/blob/main/renovate.json) file

* [ ] Choose [Google font](https://github.com/hossain-khan/android-compose-app-template/blob/main/app/src/main/java/app/example/ui/theme/Type.kt#L16-L30) for your app, or remove it.

## Demo 📹

Here is a demo of the template app containing screens shown in the 📖 [circuit tutorial](https://slackhq.github.io/circuit/tutorial/) doc.

https://github.com/user-attachments/assets/56d6f28b-5b46-4aac-a30e-80116986589e