Description
A simple Github template that lets you create an Android/Kotlin project and be up and running in a few seconds.
This template is focused on delivering a project with static analysis and continuous integration already in place.
kotlin-android-template alternatives and similar packages
Based on the "Kotlin" category.
Alternatively, view kotlin-android-template alternatives based on common mentions on social networks and blogs.
-
android-youtube-player
YouTube Player library for Android and Chromecast, stable and customizable. -
CalendarView
A highly customizable calendar view and compose library for Android. -
Balloon
:balloon: Modernized and sophisticated tooltips, fully customizable with an arrow and animations for Android. -
Kotterknife
Android view injection writen in Kotlin based on ButterKnife -
Shortbread
Android library that creates app shortcuts from annotations -
NotyKT 🖊️
📒 NotyKT is a complete 💎Kotlin-stack (Backend + Android) 📱 application built to demonstrate the use of Modern development tools with best practices implementation🦸. -
Material Chip View
Material Chip view. Can be used as tags for categories, contacts or creating text clouds -
DrawableToolbox
🛠️ The missing drawable toolbox for Android. Create drawables programmatically and get rid of the boring and always repeated drawable.xml files. -
Navigation Toolbar for Android
:octocat: Navigation toolbar is a slide-modeled UI navigation controller made by @Ramotion -
CodeView
Display code with syntax highlighting :sparkles: in native way. -
Time
Type-safe time calculations in Kotlin, powered by generics. -
Carousel Recyclerview
Carousel Recyclerview let's you create carousel layout with the power of recyclerview by creating custom layout manager. -
Pluto Debug Framework
Pluto is a on-device debugging framework for Android applications, which helps in inspection of HTTP requests/responses, capture Crashes and ANRs and manipulating application data on-the-go. -
Yasha
A DSL library for rendering RecyclerView and ViewPager. -
CrunchyCalendar — awesome calendar widget for android apps
A beautiful material calendar with endless scroll, range selection and a lot more! -
Android Kotlin Samples
Some basic samples of Kotlin for Android -
MaterialTimelineView
With MaterialTimelineView you can easily create a material looking timeline. -
sliding-panel
Android sliding panel that is part of the view hierarchy, not above it. -
MaterialDrawerKt
A Kotlin DSL wrapper around the mikepenz/MaterialDrawer library. -
Pdf Viewer For Android
A Lightweight PDF Viewer Android library which only occupies around 125kb while most of the Pdf viewer occupies up to 16MB space. -
Capturable
🚀Jetpack Compose utility library for capturing Composable content and transforming it into Bitmap Image🖼️ -
Transition X
{ } Declarative Kotlin DSL for choreographing Android transitions -
SSComposeCookBook
A Collection of major Jetpack compose UI components which are commonly used.🎉🔝👌 -
Only
:bouquet: An easy way to persist and run code block only as many times as necessary on Android. -
Swagger Gradle Codegen
💫 A Gradle Plugin to generate your networking code from Swagger -
SSCustomBottomNavigation
Animated TabBar with native control and Jetpack Navigation support..✨🔖🚀 -
EasyPermissions-ktx
🔓 Kotlin version of the popular google/easypermissions wrapper library to simplify basic system permissions logic on Android M or higher. -
Awesome Jetpack compose
A collaborative list of awesome jetpack compose resources. -
DeviceInfo-Sample
[Android Library] Get easy access to device information super fast, real quick -
Permission Flow for Android
Know about real-time state of a Android app Permissions with Kotlin Flow APIs. -
CameraViewEx
Easy Android camera integration, advanced features. -
Aimybox voice assistant
Embeddable custom voice assistant for Android applications -
Nextflix-Composable
Includes jetpack compose, navigation, paging, hilt, retrofit, coil, coroutines, flow.. -
Intro Showcase View
Highlight different features of the app using Jetpack Compose -
Events Calendar
Events Calendar is a user-friendly library that helps you achieve a cool Calendar UI with events mapping. You can customise every pixel of the calendar as per your wish and still achieve in implementing all the functionalities of the native android calendar in addition with adding dots to the calendar which represents the presence of an event on the respective dates. It can be done easily, you are just a few steps away from implementing your own badass looking Calendar for your very own project! -
ZoomHelper
ZoomHelper will make any view to be zoomable just like Instagram pinch-to-zoom -
SSCustomEditTextOutLineBorder
Same as the Outlined text fields presented on the Material Design page but with some dynamic changes. 📝 🎉 -
Maildroid
Maildroid is a small robust android library for sending emails using SMTP server -
Vanilla Place Picker
Simple(vanilla) yet 'Do it all' place picker for your place picking needs in Android -
Mutekt
Simplify mutating "immutable" state models (a Kotlin multiplatform library) -
Turtle 🐢
Run shell commands from a Kotlin script or application with ease -
Crowdin Android SDK
Crowdin Android SDK delivers all new translations from Crowdin project to the application immediately -
Compose Compiler Reports to HTML Generator
A utility (Gradle Plugin + CLI) to convert Jetpack Compose compiler metrics and reports to beautified HTML page. -
TimelineView
A customizable and easy-to-use Timeline View library for Android. Works as a RecyclerView decorator (ItemDecoration) -
EasyCrypt
Android cryptography library with SecureRandom patches.
Appwrite - The Open Source Firebase alternative introduces iOS support
Do you think we are missing an alternative of kotlin-android-template or a related project?
README
kotlin-android-template 🤖
A simple Github template that lets you create an Android/Kotlin project and be up and running in a few seconds.
This template is focused on delivering a project with static analysis and continuous integration already in place.
How to use 👣
Just click on button to create a new repo starting from this template.
Once created don't forget to update the:
- [App ID](buildSrc/src/main/java/Coordinates.kt)
- AndroidManifest ([here](app/src/main/AndroidManifest.xml) and [here](library-android/src/main/AndroidManifest.xml))
- Package of the source files
Features 🎨
- 100% Kotlin-only template.
- 4 Sample modules (Android app, Android library, Kotlin library, Jetpack Compose Activity).
- Jetpack Compose setup ready to use.
- Sample Espresso, Instrumentation & JUnit tests.
- 100% Gradle Kotlin DSL setup.
- CI Setup with GitHub Actions.
- Publish to Maven Central with Github Actions.
- Dependency versions managed via
buildSrc
. - Kotlin Static Analysis via
detekt
andktlint
. - Issues Template (bug report + feature request).
- Pull Request Template.
Gradle Setup 🐘
This template is using Gradle Kotlin DSL as well as the Plugin DSL to setup the build.
Dependencies are centralized inside the Gradle Version Catalog in the [libs.versions.toml](gradle/libs.versions.toml) file in the gradle
folder.
Static Analysis 🔍
This template is using detekt to analyze the source code, with the configuration that is stored in the [detekt.yml](config/detekt/detekt.yml) file (the file has been generated with the detektGenerateConfig
task). It also uses the detekt-formatting plugin which includes the ktlint rules (see https://detekt.dev/docs/rules/formatting/).
CI ⚙️
This template is using GitHub Actions as CI. You don't need to setup any external service and you should have a running CI once you start using this template.
There are currently the following workflows available:
- [Validate Gradle Wrapper](.github/workflows/gradle-wrapper-validation.yml) - Will check that the gradle wrapper has a valid checksum
- [Pre Merge Checks](.github/workflows/pre-merge.yaml) - Will run the
build
,check
andpublishToMavenLocal
tasks. - [Publish Snapshot](.github/workflows/publish-snapshot.yaml) - Will publish a
-SNAPSHOT
of the libraries to Sonatype. - [Publish Release](.github/workflows/publish-release.yaml) - Will publish a new release version of the libraries to Maven Central on tag pushes.
Publishing 🚀
The template is setup to be ready to publish a library/artifact on a Maven Repository.
For every module you want to publish you simply have to add the publish
plugin:
plugins {
publish
}
To Maven Central
In order to use this template to publish on Maven Central, you need to configure some secrets on your repository:
Secret name | Value |
---|---|
ORG_GRADLE_PROJECT_NEXUS_USERNAME |
The username you use to access Sonatype's services (such as Nexus and Jira) |
ORG_GRADLE_PROJECT_NEXUS_PASSWORD |
The password you use to access Sonatype's services (such as Nexus and Jira) |
ORG_GRADLE_PROJECT_SIGNING_KEY |
The GPG Private key to sign your artifacts. You can obtain it with gpg --armor --export-secret-keys <[email protected]> or you can create one key online on pgpkeygen.com. The key starts with a -----BEGIN PGP PRIVATE KEY BLOCK----- . |
ORG_GRADLE_PROJECT_SIGNING_PWD |
The passphrase to unlock your private key (you picked it when creating the key). |
The template already sets up Dokka for project documentation and attaches -sources.jar
to your publications,
via the new AGP publishing DSL.
Once set up, the following workflows will take care of publishing:
- [Publish Snapshot](.github/workflows/publish-snapshot.yaml) - To publish
-SNAPSHOT
versions to Sonatype. The workflow is setup to run either manually (withworkflow_dispatch
) or on every merge. - [Publish Release](.github/workflows/publish-release.yaml) - Will publish a new release version of the libraries to Maven Central on tag pushes. You can trigger the workflow also manually if needed.
To Jitpack
If you're using JitPack, you don't need any further configuration and you can just configure the repo on JitPack.
You probably want to disable the [Publish Snapshot] and [Publish Release](.github/workflows/publish-release.yaml) workflows (delete the files), as Jitpack will take care of that for you.
Project Structure
The project includes three sub-projects, each in their own subdirectories:
app
: The source for the final Android application.library-android
: The source for an Android library including UI.library-kotlin
: The source for a UI-less Kotlin library.library-compose
: The source for a UI library with Jetpack Compose library.
The following additional top-level directories configure & support building the app & projects:
buildSrc
: Contains shared Gradle logic as precompiled script pluginsconfig
: Contains the Detekt configuration file.gradle
: Contains Gradle Configuration files such as the Gradle Version Catalog and the Gradle Wrapper.
Finally, the following hidden top-level directories provide functionality for specific development systems:
.github
: Defines the Github Actions CI tasks and templates for new pull requests, issues, etc..idea
: Sets common initial project settings when the project is opened in Android Studio or IntelliJ IDEA.
Contributing 🤝
Feel free to open a issue or submit a pull request for any bugs/improvements.
*Note that all licence references and agreements mentioned in the kotlin-android-template README section above
are relevant to that project's source code only.