README.md

Android Project Template

Use this template project to improve your project setup experience.

Contents

• recommended package structure
• multi module
• latest libraries (AndroidX, Retrofit, Moshi, A3 libraries, Timber, LeakCanary)
• flavor dimension for development environments (dev, staging, live)
• Retrofit + Moshi setup
• Firebase Analytics and Messaging setup
• Splash screen setup: https://developer.android.com/guide/topics/ui/splash-screen
• Google Play services Open Source Notices activity
• (optional) Texterify setup
• ktlint integration via ktlint-gradle-plugin

Project Setup (using this template)

Install Cookiecutter and run the following command to fetch and use this template:

cookiecutter gh:allaboutapps/A3AndroidTemplate

Supply the following values when prompted:

1. repo_name - Directory name where to create the new project (e.g.: myproject-android)
2. app_name - App name (pretty/display name)
3. package_name - App package name (e.g.: com.example.app)
4. package_name_dir - Directory of the app package, relative to the app/src/main/java directory. (used to generate the correct directory structure)
   Default value is the same as package_name, with dots/periods replaced with slashes.
5. string_tool - The string-export tool for this project (none or texterify)
6. texterify_project_id - ID of your Texterify project (default is empty)
7. texterify_export_config - Export Configuration ID of your Texterify project (default is empty)
8. firebase_analytics - Whether or not to setup Firebase Analytics (default: no)
9. firebase_messaging - Whether or not to add basic setup for FCM (default: no)

Texterify

To fetch the latest strings from the configured Texterify project, run the gradle task updateStrings. The config file texterify.json is located in the app directory.

Open Source Notices

To show the Google Play services' Open Source Notices activity just add the following code:

startActivity(Intent(this, OssLicensesMenuActivity::class.java))

More details can be found in the Google Play services documentation.

---

Du suchst einen spannenden Job im Mobile Bereich? Looking for a job?

We're hiring @all about apps