This GitHub template repository serves as a starting point for developing Android applications. I've started this Android application template using Adam's template. Along with the existing tools, I've added some features that align with my specific needs. These enhancements aim to make the development process smoother and improve the app's functionality. However, I'm open to suggestions and improvements. If you think there are other important elements to include or have recommendations for modifying the current setup, please share your thoughts. Your input is highly appreciated. Note that, since Adam did a really good job with the documentation, I left it mostly unchanged.
The purpose of this template is to avoid any opinions on writing code. The developers should have the freedom to choose their own architecture, third party dependencies, package structure, and more.
This template is opinionated about developer tooling. Dependency management is configured, git hooks are defined, code formatting and static analysis are all there, and it even has pull request templates. The purpose of this repo is to help you get started building your next project with confidence in your code, and not telling you how to write it.
If you'd like a video walk through of this template and all it has to offer, you can find that on YouTube.
To use this template in your own project, click the "Use this template" button at the top right of the repository. Once you do, a repository will be created for your account that you can clone and use on your device.
To setup this repository to your needs, open the setup.gradle file
and tweak the renameConfig block to your needs. After that, you can run the renameTemplate
gradle task to have the app module's package name and relevant strings replaced.
A number of third party dependencies are included in this template. They are also documented inside the documentation folder. The files inside this documentation folder are written in such a way that you can keep them in your real project, to let team members read up on why dependencies are included and how they work.
The dependencies in the template include:
- Ktlint for formatting.
- Detekt for code smells.
- Git Hooks for automatically perform static analysis checks.
- GitHub Actions for running continuous integration and ensuring code quality with every PR.
- LeakCanary for detecting memory leaks.
- Hilt dependencies, which can be removed via setup.gradle if necessary.
- Room dependencies, which can be removed via setup.gradle if necessary.
There are also templates within this template. This repo comes shipped with a Pull Request Template that will help you and your team write organized and detailed pull request descriptions.
You may notice that dependencies are set up in a very specific way. Each of the tools has its own Gradle file in the buildscripts folder. This is by design so that if you chose to have a multi module project, these dependencies can easily be shared between them. This is already configured inside our root build.gradle.kts file, by applying to each sub project:
subprojects {
apply from: "../buildscripts/versionsplugin.gradle"
}In addition, all of the app module dependencies are defined using a gradle version catalog, found in this toml file.