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 library setup for the app
• ✔️ Dependency Injection for all Circuit Screens & Presenter combo
• ✔️ Ktlint task in Gradle
• ✔️ GitHub Actions for CI
• ✔️ Google font for choosing different app font.

Warning

This template is only for Android app setup. If you are looking for a multi-platform supported template, look at the official 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 in XML and Gradle
• Update your app theme colors (use Theme Builder)
• Generate your app icon (use Icon Kitchen)
• Rename ComposeApp*** to preferred file names
• Remove Example*** files that were added to showcase example usage of app and Circuit.
• Choose Google font for your app, or remove it.

Demo 📹

Here is a demo of the template app containing screens shown in the 📖 circuit tutorial doc.

Circuit-Template-App-DEMO.mp4