Skip to content

Android Jetpack MVVM Boilerplate. Integrated with Jetpack dependencies, Hilt, Room, Okhttp, Retrofit, etc.

License

Notifications You must be signed in to change notification settings

johnnymillergh/AndroidJetpackMVVMBoilerplate

Repository files navigation

Android Jetpack MVVM Boilerplate Social Image GitHub release Android CI GitHub issues GitHub forks GitHub stars GitHub license GitHub code size in bytes GitHub repo size Twitter

Android Jetpack MVVM Boilerplate

Android Jetpack MVVM Boilerplate a Jetpack based, MVVM boilerplate template project for Modern Android.

Features

Here is the highlights of Android Jetpack MVVM Boilerplate:

  1. Inherited from the most modern and newest Spring frameworks:

    org.springframework.boot:spring-boot-starter-parent - Spring Boot org.springframework.cloud:spring-cloud-dependencies - Spring Cloud

Usage

  1. Clone or download this project.

    $ git clone https://github.com/johnnymillergh/AndroidJetpackMVVMBoilerplate.git
  2. Build with latest Android Studio.

  3. Click the green triangle to Run.

Useful Commands

Gradle

  1. Compile and package:

    $ gradle clean build

Conventional Changelog CLI

  1. Install global dependencies (optional if installed):

    $ npm install -g conventional-changelog-cli
  2. This will not overwrite any previous changelogs. The above generates a changelog based on commits since the last semver tag that matches the pattern of "Feature", "Fix", "Performance Improvement" or "Breaking Changes".

    $ conventional-changelog -p angular -i CHANGELOG.md -s
  3. If this is your first time using this tool and you want to generate all previous changelogs, you could do:

    $ conventional-changelog -p angular -i CHANGELOG.md -s -r 0

CI (Continuous Integration)

  • GitHub Actions is for building and testing.
  • Deprecated Travis CI is for publishing Docker Hub images of SNAPSHOT and RELEASE.

Maintainers

@johnnymillergh.

Contributing

Feel free to dive in! Open an issue.

Contributors

This project exists thanks to all the people who contribute.

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

Apache License © Johnny Miller

2021 - Present