Skip to content

Latest commit

 

History

History
183 lines (121 loc) · 7.35 KB

README.md

File metadata and controls

183 lines (121 loc) · 7.35 KB
Raw

Forlago 🍷 (work-in-progress 👷🔧️👷‍♀️⛏)

CI License Language

A Github template that lets you create an enterprise grade Android / Compose Only / Single Activity / Multi Module application project.

How to use 👣

Just click on Use this template button to create a new repo starting from this template.

After successfully forking the template you have to:

  • Replace all the occurrences of com.leinardi.forlago with the Application ID of your new project
  • Replace all the occurrences of forlago/Forlago/FORLAGO with the name of your new project (remember to preserve the case!)
  • Rename all the files containing forlago/Forlago/FORLAGO (e.g ForlagoNavigator.kt -> YourProjectNameNavigator.kt)
  • Generate a new debug and release keystores release/app-debug.jks (see Release section below)
  • Replace the App icons (you can generate new icons using icon.kitchen by @romannurik)

Features 🎨

  • 100% Kotlin-only Android code
  • Compose only - Single Activity application
  • Multi Module project structure
  • CI Setup with GitHub Actions
  • Dependency versions managed via libs.versions.toml

Gradle Setup 🐘

TBD

Gradle modules' dependency graph

Static Analysis 🔍

TBD

CI ⚙️

This template is using GitHub Actions as CI. You don't need to setup any external service and you should have a running CI once you start using this template.

There are currently the following workflows available:

  • CI - Will be triggered on every new PR or every new commit pushed to the master branch.

Release

Generating new keystores

Generating debug keystore

keytool -genkeypair -dname "cn=First Last Name, ou=Mobile, o=My Company, c=US" -alias androiddebugkey -keypass android -keystore release/app-debug.jks -storepass android -keyalg RSA -sigalg SHA256withRSA -keysize 2048 -validity 9999

Generating release keystore

keytool -genkeypair -dname "cn=First Last Name, ou=Mobile, o=My Company, c=US" -alias release -keypass <STRONG PASSWORD GOES HERE> -keystore release/app-release.jks -storepass <STRONG PASSWORD GOES HERE> -keyalg RSA -sigalg SHA256withRSA -keysize 2048 -validity 9999

Add the release keystore and the encrypt secret passwords to the GitHub Actions secrets as RELEASE_KEYSTORE_PWD and ENCRYPT_KEY.

Publishing on the Play Store

Prerequisites

To publish your app on the Play Store you need to create a service account with access to the Play Developer API and generate a new play-account.gpg file. You can find instructions on how to generate a new service account here. Once you have the JSON key, place it in release/play-account.json.

Managing Play Store metadata

Gradle Play Publisher (GPP) can do anything from building, uploading, and then promoting your App Bundle or APK to publishing app listings and other metadata. Have a look at the folder app/src/main/play and the official GPP documentation to learn more about managing Play Store metadata.

Publishing

Once everything is properly configured, you can run the release.yml workflow to create a new release and upload the bundle to the Play Store.

Enabling Firebase Crashlytics

The first step is to register your new app with Firebase (don't forget to add both release and debug packages to the same Firebase project). After that, you should put the google-services.json, containing both release and debug applications, inside the app/ directory. Now you have to Enable Crashlytics in the Firebase console and, finally, open the Debug menu and trigger a crash using the Force Crash button.

Encrypting your secrets

Once you have these 3 files in the following paths:

  • release/app-release.jks
  • release/play-account.json
  • app/google-services.json

you can use the release/encrypt-secrets.sh to safely encrypt them (it's recommended to use a very strong passphrase).

Get the latest version of the GraphQL schema

./gradlew :module:library-network-api:downloadForlagoApolloSchemaFromIntrospection

Baseline Profile

Baseline Profiles improve code execution speed from the first launch by avoiding interpretation and just-in-time (JIT) compilation steps for included code paths.

How to generate Baseline profile

Just run this command, and it will generate baseline-profile.txt to add to the project:

./gradlew :macrobenchmark:forlago:pixel6Api31BenchmarkAndroidTest -Pandroid.testInstrumentationRunnerArguments.androidx.benchmark.enabledRules=BaselineProfile -Dorg.gradle.workers.max=4

The baseline profile generated will be at this path:

macrobenchmark/build/outputs/managed_device_android_test_additional_output/pixel6Api31/BaselineProfileGenerator_startup-baseline-prof.txt

And you have to rename and move it to:

apps/forlago/src/main/baselineProfiles/baseline-prof.txt

Contributing 🤝

Feel free to open a issue or submit a pull request for any bugs/improvements.

Licenses

Copyright 2021 Roberto Leinardi.

Licensed to the Apache Software Foundation (ASF) under one or more contributor
license agreements.  See the NOTICE file distributed with this work for
additional information regarding copyright ownership.  The ASF licenses this
file to you 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.

WIP

adb shell am start -d "forlago://bar/FooText" -a android.intent.action.VIEW
adb shell am start -d "forlago://debug" -a android.intent.action.VIEW

Inspired by the following open source projects:

privacy policy link