Code Base Generator for Android Project

A Boilerplate code generator for creating Android project. Using Kotlin and MVVM pattern that refer to Android Jetpack. This boilerplate using PokéAPI for sample data source list.

• Kotlin
• MVVM
• View Binding
• Dagger 2
• Retrofit 2
• Paging Library
• Room
• ReactiveX
• Timber
• Glide
• Coroutines
• Kotlin DSL

Install yeoman using NPM

npm install -g yo

Create your project directory

mkdir MyNewApp
cd MyNewApp/

Install generator using NPM

npm install -g generator-android-kotlin-mvvm

New Node and npm users might run into permissions issues. These issues show up in the form of EACCESS errors during installation. Refer to the npm guide to fix permissions if this happens to you.

On Windows, we suggest using a better command line tool such as cmder or PowerShell to improve the experience.

Run Generator using Yeoman

yo android-kotlin-mvvm

Once boilerplate generated sucessfully, open it using Android Studio, sync/rebuild your project, and done! Check Wiki for more information how to use this boilerplate.

Make sure you are using java version 17 before try to sync/build the source. Configure it at android studio -> file -> project structure -> SDK location -> gradle settings -> gradle JDK

Most issues can be found by running:

yo doctor

The doctor command will diagnose and provide steps to resolve the most common issues.