Android Studio MVP Template

This is an Android Studio template for MVP.

It is inspired by u2020-mvp-android-studio-template and follows Antonio Leiva's MVP implementation guide for Android.

Here's the hierarchy it follows:

com.company.app
    +-- injection
    |   - ActivityScope
    |   - AppComponent
    |   - AppModule
    |   - FragmentScope
    |   - MainViewComponent
    |   - MainViewModule
    +-- interactor
    |   +-- impl
    |       - MainViewInteractorImpl
    |   - BaseInteractor
    |   - MainViewInteractor
    +-- presenter
    |   +-- impl
    |       - MainViewPresenterImpl
    |   - BasePresenter
    |   - MainViewPresenter
    +-- view
    |   +-- impl
    |       - BaseActivity
    |       - BaseFragment
    |       - MainActivity
    |   - MainView
    | - YourApp

Prerequisites

You must use Dagger 2 for dependency injection and AppCompat for annotations and base classes.

Installation

For Mac:

Just copy all 3 directories MVPFragment, MVPActivity and MVPBoilerplate to $ANDROID_STUDIO_FOLDER$/Contents/plugins/android/lib/templates/activities/

For Windows:

Just copy all 3 directories MVPFragment, MVPActivity and MVPBoilerplate to $ANDROID_STUDIO_FOLDER$\plugins\android\lib\templates\activities\

How to use

1. Generate base boilerplate

First of all, create the base hierarchy and classes using MVP Boilerplate from the root package folder. This needs to be done only once per project:

It will generate an App class that you should use as your Application, an ActivityScope, FragmentScope, AppModule and AppComponent for injection, a BaseActivity, BaseFragment, BasePresenter and BaseInteractor.

Be sure to use the generated App as your Application into your manifest!

2. Create your first activity

Then you can create a new MVP Activity. It will create:

An Activity
A layout for your Activity
A Component and a Module for Dagger 2 injection
A View interface for your Activity
A Presenter interface and default implementation class
An Interactor interface and default implementation class for your model

It's important that you create it from the root package, otherwise it will re-create the whole MVP hierarchy under your subpackage which is not what you want.

License

Copyright 2016 Benoit LETONDOR

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

jhonween / Android-Studio-MVP-template