Golden Sample Android App

The golden sample is a public repository that contains samples, examples and best practices. This repository should be used internally and externally to show the Backbase approach, architecture and way of working to our developers and customers.

Samples

Every sample lives on its own branch. The CATALOG.md file lists all the samples that the repo contains. The repository is updated with every LTS releases and these updates are tagged, you can easily compare a sample to the tag to see the code changes.

Contribution

If you want to create your own samples check the CONTRIBUTING.md for the guidelines.

Discussion

You can discuss samples, request new examples and report problems on Github Discussions.

💻 Getting started

This project depends on various artifacts published to repositories on Backbase Repo. You must have read access to these repositories to build this project. The project also requires a specific keystore in order for the app to communicate with the backend. In order to configure the project, please follow this guide on Backbase.io.

Note that this project connects to the EBP Sandbox Environment, for that you need to request an API key as mentioned here. Add the key to the config.json file in the assets folder.

📱 Login

In order to login you can find user credentials at user-credentials page

The Journey Architecture

Backbase mobile is built with the journey architecture, where a journey is an independent set of screens that form a typical user journey. To learn more about the Backbase journey architecture read this guide.

Test Suites Overview

The project includes testing, demonstrating how to test the journey through unit tests, instrumented tests, and screenshot tests. It also highlights how to generate code coverage reports by using Jacoco.

Run Unit Tests

./gradlew testDebug

Run Instrumented and Screenshot tests

accounts-journey
This module includes unit tests, UI tests, and screenshot tests.
All tests use mocks and are not connected to any external services.

./gradlew accounts-journey:cAT

accounts-demo
This module contains End-to-End UI tests for the Accounts Journey, connected to the EBP Sandbox Environment.

Important

A test account must be configured before running tests. Provide credentials by editing accounts-demo/build.gradle.kts using the EBP Sandbox user credentials.

./gradlew accounts-demo:cAT

app
This module includes End-to-End UI tests of the app, connected to the EBP Sandbox Environment.

Important

A test account must be configured before running tests. Provide credentials by editing app/build.gradle.kts using the EBP Sandbox user credentials.

./gradlew app:cAT

Run code coverage and root code coverage

./gradlew codeCoverageReport
./gradlew rootCodeCoverageReport

Run coverage verification and root coverage verification

./gradlew coverageVerification
./gradlew rootCoverageVerification

Static code analysis

The project uses Detekt for identifying code smells and performance issues.

./gradlew detekt
./gradlew detektTest