start-android

A simple Github template that lets you create an Android/Kotlin project and be up and running in a few seconds.

Inspired by https://github.com/cortinico/kscript-template

How to use

Just click on button to create a new repo starting from this template.

Once created, GitHub Actions should initialize your repository (usually takes less than 30 seconds).

Edit online your configuration!

Try it on Kotlin Playground https://pl.kotl.in/9oXsIoDNS or our samples here

Todo list

• Create a new template project.
• Edit newmodule.kt configuration.
  • Need help? Try it on Kotlin Playground or our samples here.
• Run workflow Build Modules
• Choose a LICENSE.
• Set your ORG_GRADLE_PROJECT_NEXUS_USERNAME, ORG_GRADLE_PROJECT_NEXUS_PASSWORD, ORG_GRADLE_PROJECT_SIGNING_KEY and ORG_GRADLE_PROJECT_SIGNING_PWD secrets in Settings.
• Code some cool apps and libraries 🚀.

Features

• 100% Kotlin-only template.
• 3 Sample modules (Android app, Android library, Kotlin library).
• 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 ktlint and detekt.
• Issues Template (bug report + feature request).
• Pull Request Template.

Powered by GitHub Actions

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.

The workflow Start will take care of running the script and do the setup step.

Contributing 🤝

Feel free to open a issue or submit a pull request for any bugs/improvements.