README.md

Android Lib template using cookiecutter

By Romell Domínguez

Requirements to use the cookiecutter template:

---

• Python 2.7 or 3.6
• Cookiecutter Python package >= 1.4.0: This can be installed with pip by or conda depending on how you manage your Python packages:

$ pip install cookiecutter

or

$ conda config --add channels conda-forge
$ conda install cookiecutter

To develop a new kotlin DSL project, run:

---

cookiecutter  gh:romellfudi/AndroidLibProject --checkout kotlin_dsl

To develop a new kotlin project, run:

---

cookiecutter  gh:romellfudi/AndroidLibProject --checkout kotlin

To develop a new java project, run:

---

cookiecutter  gh:romellfudi/AndroidLibProject --checkout java

Project Organization in Java & Kotlin

.
app_name
├── LICENSE
├── README.md
├── app
│   ├── build.gradle
│   ├── proguard-rules.pro
│   └── src
│       ├── androidTest
│       │   └── java
│       │       └── package_dir
│       │           └── ExampleInstrumentedTest
│       └── main
│           ├── AndroidManifest.xml
│           ├── java
│           │   └── package_dir
│           │       └── MainActivity
│           └── res
├── build.gradle
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradle.properties
├── gradlew
├── gradlew.bat
├── settings.gradle
└── lib_name
    ├── build.gradle
    ├── proguard-rules.pro
    └── src
        ├── main
        │   ├── AndroidManifest.xml
        │   ├── java
        │   │   └── lib_package_dir
        │   │       ├── APICache
        │   │       ├── APIException
        │   │       ├── Api
        │   │       ├── ApiAbstract
        │   │       ├── Callback
        │   │       ├── DataResponse
        │   │       └── Module
        │   └── res
        └── test
            └── java
                └── lib_package_dir
                    └── ExampleUnitTest

Project Organization in Kotlin DSL

.
├── LICENSE
├── README.md
├── app
│   ├── build.gradle.kts
│   ├── proguard-rules.pro
│   └── src
│       ├── androidTest
│       │   └── java
│       │       └── package_dir
│       │           └── ExampleInstrumentedTest.kt
│       └── main
│           ├── AndroidManifest.xml
│           ├── assets
│           │   └── seed
│           │       ├── options.json
│           │       └── questions.json
│           ├── java
│           │   └── package_dir
│           │       ├── App.kt
│           │       ├── data
│           │       ├── di
│           │       ├── model
│           │       ├── ui
│           │       └── util
│           └── res
├── build.gradle.kts
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradle.properties
├── gradlew
├── gradlew.bat
├── ktlint.gradle.kts
├── local.properties
├── settings.gradle.kts
└── lib_name
    ├── build.gradle.kts
    ├── proguard-rules.pro
    └── src
        ├── main
        │   ├── AndroidManifest.xml
        │   ├── java
        │   │   └── lib_package_dir
        │   │       ├── APICache.kt
        │   │       ├── APIException.kt
        │   │       ├── Api.kt
        │   │       ├── ApiAbstract.kt
        │   │       ├── Callback.kt
        │   │       ├── DataResponse.kt
        │   │       └── Module.kt
        │   └── res
        │       └── values
        │           └── strings.xml
        └── test
            └── java
                └── lib_package_dir
                    └── ExampleUnitTest.kt

cookiecutter template for Gradle-based Android projects.

License

MIT. See the LICENSE file for the copyright notice.

Updated 2021, Febrero