Master - koin (do not merge)

.editorconfig

@@ -2,4 +2,26 @@
 # Comma-separated list of rules to disable (Since 0.34.0)
 # Note that rules in any ruleset other than the standard ruleset will need to be prefixed
 # by the ruleset identifier.
-disabled_rules=import-ordering,experimental:annotation
+disabled_rules=no-wildcard-imports,import-ordering,experimental:annotation
+ij_kotlin_code_style_defaults = KOTLIN_OFFICIAL
+
+ij_kotlin_line_comment_at_first_column = false
+ij_kotlin_line_comment_add_space = true
+
+# These options can keep to use single name import
+ij_kotlin_name_count_to_use_star_import = 2147483647
+ij_kotlin_name_count_to_use_star_import_for_members = 2147483647
+
+ij_kotlin_keep_blank_lines_in_declarations = 1
+ij_kotlin_keep_blank_lines_in_code = 1
+ij_kotlin_keep_blank_lines_before_right_brace = 0
+
+# optional but recommended
+ij_kotlin_align_multiline_parameters = false
+
+# optional but recommended
+ij_continuation_indent_size = 4
+
+# Android specific rules
+ij_kotlin_import_nested_classes = false
+ij_kotlin_imports_layout = *,^

.github/workflows/cicd.yml

@@ -0,0 +1,83 @@
+name: Continuous Integration
+
+on:
+  push:
+  pull_request:
+
+env:
+  LANG: en_US.UTF-8
+  # Notifications
+  SLACK_WEBHOOK_URL: ${{ secrets.SLACK_URL }}
+  SLACK_CHANNEL: '#dev-builds'
+
+jobs:
+
+  ci:
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Install Fastlane and required plugins
+      run: |
+        sudo gem install bundler -v "$(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1)"
+        bundle install --path vendor/bundle    
+    # Runs build with Gradle
+    - name: Build with Fastlane
+      run: bundle exec fastlane debug
+    - name: Send notification of build result
+      uses: 8398a7/action-slack@v3
+      with:
+        status: ${{ job.status }}
+        text: '${{github.repository}} Dev build status is ${{ job.status }}'
+        fields: repo,message,commit,author,action,eventName,ref,workflow,job,took
+      if: always()  
+
+
+  release:
+    if: ${{ github.ref == 'refs/heads/develop' || github.ref == 'refs/heads/master' }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    env:
+      # S3
+      FOLDER: android-base
+      AWS_REGION: us-east-1
+      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+      KEYS_BUCKET: ${{ secrets.AWS_S3_KEYS_BUCKET }}
+      # Android Release
+      JSON_KEYFILE: google-api.json
+      RELEASE_STORE_FILE: key.keystore
+      RELEASE_STORE_PASSWORD: ${{ secrets.ANDROID_RELEASE_STORE_PASSWORD }}
+      RELEASE_KEY_ALIAS: debug
+      RELEASE_KEY_PASSWORD: ${{ secrets.ANDROID_RELEASE_KEY_PASSWORD }}
+      # Notifications
+      SLACK_URL: ${{ secrets.SLACK_URL }}
+      SLACK_CHANNEL: '#dev-builds'
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    # Downloads certificate, private key and Firebase file
+    - name: Download code signing items
+      run: | 
+        aws s3 cp s3://$KEYS_BUCKET/$FOLDER/ . --recursive
+        mv ./android/$RELEASE_STORE_FILE ./app/$RELEASE_STORE_FILE
+    - name: Install Fastlane and required plugins
+      run: |
+        sudo gem install bundler
+        bundle install --path vendor/bundle
+    # Build with Gradle and submit to Play Store
+    - name: Submit Development build with Fastlane
+      if: ${{ github.ref == 'refs/heads/develop' }}
+      run: bundle exec fastlane deploy_dev
+    - name: Submit Staging build with Fastlane
+      if: ${{ github.ref == 'refs/heads/master' }}
+      run: bundle exec fastlane deploy_staging
+    - name: Send notification of build result
+      uses: 8398a7/action-slack@v3
+      with:
+        status: ${{ job.status }}
+        text: '${{github.repository}} ${{github.ref}} build submission status is ${{ job.status }}'
+        fields: repo,message,commit,author,action,eventName,ref,workflow,job,took
+      if: always()  
+

.gitignore

@@ -10,10 +10,14 @@
 /.idea/assetWizardSettings.xml
 /.idea/gradle.xml
 /.idea/*
-/secure/*
 /app/prod/release/*
 /fastlane/report.xml
 .DS_Store
 /build
 /captures
 .externalNativeBuild
+.gitsecret/keys/random_seed
+fastlane/report.xml
+!*.secret
+/secure/key.keystore
+/secure/google-api.json

.gitsecret/paths/mapping.cfg

@@ -0,0 +1,3 @@
+secure/google-api.json:e494b2376306f39ea643ebe13156e4b885cddb64755a3a3fe4dd5f2807cb9a70
+secure/key.keystore:6c70718b97803ac753020362b214a40762dc4ed95c4665648f86758c20ddbae9
+gradle.properties:2a428ac440037c87d1001976c703d0ea412dee852aae78d9827f1307c4604545

Gemfile.lock

@@ -178,4 +178,4 @@ DEPENDENCIES
   fastlane-plugin-increment_version_code
 
 BUNDLED WITH
-   1.17.2
+   2.1.2

README.md

@@ -39,6 +39,58 @@ to handle the server side authentication, in case you need to modify them:
 ## Usage
 - You can use this open source project as a template of your new Android projects.
 
+## Key File encryption
+
+Build signing requires a developer-owned keystore. Location and credentials for it are specified in `gradle.properties`. Likewise submission to Google Play requires a Developer API key in .json format (`google-api.json`).
+It is recommended that these files remains outside the source repo
+
+We suggest using [git secret](https://git-secret.io/) as a simple and secure solution for keeping these sensitive files in the repo. See [Config](./secure/Readme.md) for detailed instructions.
+
+
+## Build and Release with Fastlane
+
+We provide configuration files for automating build, test and submission of the application using [Fastlane](https://docs.fastlane.tools/)
+
+### Requirements
+
+* Ensure JDK 1.8 is installed
+* Ensure proper version of Android SDK command line tools is installed
+* Install _fastlane_ using
+```
+[sudo] gem install fastlane -NV
+```
+or alternatively using `brew cask install fastlane`
+
+### Usage
+Lanes for each deployment target example are provided with some basic behavior:
+- Each target has two options: `debug_x` and `deploy_x`.
+- Each option will:
+  - Increment the build number.
+  - Run `gradlew clean`
+  - Run `gradlew androidDependencies`
+  - Build the app (`gradle assemble`) for the target flavor.
+- The `deploy` lanes will additionaly submit the APK to the corresponding track in the Play Store.
+
+Check `fastlane/Appfile` and `fastlane/Fastfile` for more information.
+
+## CI/CD configuration with Bitrise (updated on Dec 12th 2021)
+
+We are going to start using a tool called Bitrise to configure the CI/CD pipelines for mobiles apps.
+
+--> For Android apps you can find how to do it in this link: https://www.notion.so/rootstrap/Android-CI-CD-26d4abd4f2454224be8f617110147366
+
+## Continuous Integration with GitHub Actions (DEPRECATED)
+
+We provide an example workflow [cicd.yml](.github/workflows/cicd.yml) including two jobs for running under [GitHub Actions](https://docs.github.com/en/actions), which can be modified according to the specifics of each project:
+
+* `ci`
+    * runs upon every push and PR
+    * installs Fastlane and runs `debug_dev` lane
+* `release`
+    * runs upon every push to `develop` or `master`
+    * downloads keystore and Google api key from S3 (credentials need to be present in repo Secrets)
+    * installs Fastlane and runs `deploy_*` lane depending on branch (`Dev` if in `develop`, `Stsaging` if in `master`) - This could be easily modified to release `Prod` instead 
+
 ## Analytics
 - Add analytics manager:
     1. Firebase
@@ -63,6 +115,20 @@ in order to track the login event.
 - For MixPanel, you have to replace the API key: 
 `<string name="mixpanel_api_key">mixpanel_api_key</string>`
 
+
+## Utility extensions
+We have a bunch of pre-made extensions usually used on every project to accelerate feature development.
+you can access them in the util.extensions package. They include but are not limited to :
+
+- `Fragment.collectOnLifeCycle(...)` extension to reduce the boiler plate code and indentation when
+  collecting flows from a fragment.
+- `ProgressBar.progressTo(...)` extension to animate progress updates in one line with ease 
+  and with good support for older android versions.
+- `TextView.setClickableKeyword(...)` extension to add clickable functions to words or prhases inside a 
+  Textview, allowing to also change their color, font (for example, to bold the keyword), and underline
+- `TextView.setColoredKeyword(...) ` extension to change the color of a word or prhase in a Textview.
+
+
 ## Code Quality Standards
 In order to meet the required code quality standards, this project uses [Ktlint](https://github.com/pinterest/ktlint) and [Detekt](https://github.com/arturbosch/detekt)
 
@@ -78,3 +144,4 @@ NOTE: Remove the free LICENSE file for private projects or replace it with the c
 **Android Base** is maintained by [Rootstrap](http://www.rootstrap.com) with the help of our [contributors](https://github.com/rootstrap/android-base/contributors).
 
 [<img src="https://s3-us-west-1.amazonaws.com/rootstrap.com/img/rs.png" width="100"/>](http://www.rootstrap.com)
+