NOTE: Not yet completed

Android Boilerplate

Sample Android app that we use at White Cloak as a reference for new Android projects. It demonstrates the architecture, tools and guidelines that we use when developing for the Android platform.

Libraries and tools included:

• Support libraries
• RecyclerViews and CardViews
• RxJava and RxAndroid
• Dagger 2
• Butterknife
• Timber
• AutoValue with extensions AutoValueParcel and AutoValueGson

Requirements

• JDK 1.8
• Android SDK.
• Android Nougat (API 24) .
• Latest Android SDK Tools and build tools.

New project setup

To quickly start a new project from this boilerplate follow the next steps:

• Download this repository as a zip.
• Change the package name.
  • Rename packages in main, androidTest and test using Android Studio.
  • In app/build.gradle file, packageName and testInstrumentationRunner.
  • In src/main/AndroidManifest.xml and src/debug/AndroidManifest.xml.
• Create a new git repository, see GitHub tutorial.
• Replace the example code with your app code following the same architecture.
• In app/build.gradle add the signing config to enable release versions.
• Update proguard-rules.pro to keep models (see TODO in file) and add extra rules to file if needed.
• Update README with information relevant to the new project.
• Update LICENSE to match the requirements of the new project.

License

    Copyright 2016 White Cloak Technologies, Inc.

    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.