Jetpack Compose Navigation and Material3 Starter Template

This project is designed to help you get started with a simple Modern Android Development (MAD) project.

It is purpose designed to be very simple, as a way to get started, so you can add your own customizations.

Template Contents

Project includes:

It does not include:

The Color.kt file is formatted so you can copy/paste a color definition directly from the Material Theme Builder

It also includes color definitions for all the original M2 colors.

I included static analysis tooling in the build for this project. These tools help maintain consistency and are worth including in all projects.

To run static analysis on this project, execute:

./gradlew lint ktlintcheck detekt

This repo has configuration to automatically setup a pre-commit hook requiring the developer to pass static analysis before being able to commit PRs.

I'm using the Coil image caching library to make the demo a bit nicer.

There are a few Android Studio integrations in the project worth calling out:

code style - establishes consistent formatting
code insight settings - eliminates certain values from showing up in auto-complete, making dev life happier
plugin dependency list - list of essential plugins

The initial configuration is included for building on Github Actions. The build compiles the APKs, if static analysis completes without issue.

To disable CI - delete the configuration file.

Build status is:

Special thanks for the great input from:

Please contact me if you have any comments or suggestions. Twitter: mikewolfson