bitwarden / android

Bitwarden Android Contents • Compatibility • Setup • Dependencies Compatibility • **Minimum SDK**: 29 (Android 10) • **Target SDK**: 36 (Android 16) • **Device Types Supported**: Phone and Tablet • **Orientations Supported**: Portrait and Landscape Setup • Clone the repository: • Create a file in the root directory of the project and add the following properties: • : A "classic" Github Personal Access Token (PAT) with the scope (ex: ). These can be generated by going to the Github tokens page. See the Github Packages user documentation concerning authentication for more details. • : A boolean value to determine if the SDK should be loaded from the local maven artifactory (ex: ). This is particularly useful when developing new SDK capabilities. Review Linking SDK to clients for more details. • Setup the code style formatter: All code must follow the guidelines described in the Code Style Guidelines document. To aid in adhering to these rules, all contributors should apply as their code style scheme. In IntelliJ / Android Studio: • Navigate to . • Hit the button next to . • Select . • Find the file in the project's directory. • Import "from" "to" . • Hit and to save the changes and exit Preferences. Note that in some cases you may need to restart Android Studio for the changes to take effect. All code should be formatted before submitting a pull request. This can be done manually but it can also be helpful to create a macro with a custom keyboard binding to auto-format when saving. In Android Studio on OS X: • Select • Select • Select • Select • Select This can then be mapped to a set of keys by navigating to and editing the macro under (ex : shift + command + s). Please avoid mixing formatting and logical changes in the same commit/PR. When possible, fix any large formatting issues in a separate PR before opening one to make logical changes to the same code. This helps others focus on the meaningful code changes when reviewing the code. • Setup JDK : • Navigate to . • Hit the selected Gradle JDK next to . • Select a version or hit if not present. • Select . • Select your preferred . • Hit . • Hit . • Setup pre-commit hook (optional): Run the following script from the root of the repository to install the hook. This will overwrite any existing pre-commit hook if present. Dependencies Application Dependencies The following is a list of all third-party dependencies included as part of the application beyond the standard Android SDK. • **AndroidX Activity** • https://developer.android.com/jetpack/androidx/releases/activity • Purpose: Allows access composable APIs built on top of Activity. • License: Apache 2.0 • **AndroidX Appcompat** • https://developer.android.com/jetpack/androidx/releases/appcompat • Purpose: Allows access to new APIs on older API versions. • License: Apache 2.0 • **AndroidX Autofill** • https://developer.android.com/jetpack/androidx/releases/autofill • Purpose: Allows access to tools for building inline autofill UI. • License: Apache 2.0 • **AndroidX Biometrics** • https://developer.android.com/jetpack/androidx/releases/biometric • Purpose: Authenticate with biometrics or device credentials. • License: Apache 2.0 • **AndroidX Browser** • https://developer.android.com/jetpack/androidx/releases/browser • Purpose: Displays webpages with the user's default browser. • License: Apache 2.0 • **AndroidX Camera** • https://developer.android.com/jetpack/androidx/releases/camera • Purpose: Display and capture images for barcode scanning. • License: Apache 2.0 • **AndroidX Compose** • https://developer.android.com/jetpack/androidx/releases/compose • Purpose: A Kotlin-based declarative UI framework. • License: Apache 2.0 • **AndroidX Core** • https://developer.android.com/jetpack/androidx/releases/core • Purpose: Backwards compatible platform features and APIs. • License: Apache 2.0 • **AndroidX Credentials** • https://developer.android.com/jetpack/androidx/releases/credentials • Purpose: Unified access to user's credentials. • License: Apache 2.0 • **AndroidX Lifecycle** • https://developer.android.com/jetpack/androidx/releases/lifecycle • Purpose: Lifecycle aware components and tooling. • License: Apache 2.0 • **AndroidX Navigation** • https://developer.android.com/jetpack/androidx/releases/navigation • Purpose: Provides a consistent API for navigating between Android components. • License: Apache 2.0 • **AndroidX Room** • https://developer.android.com/jetpack/androidx/releases/room • Purpose: A convenient SQLite-based persistence layer for Android. • License: Apache 2.0 • **AndroidX Security** • https://developer.android.com/jetpack/androidx/releases/security • Purpose: Safely manage keys and encrypt files and sharedpreferences. • License: Apache 2.0 • **AndroidX WorkManager** • https://developer.android.com/jetpack/androidx/releases/work • Purpose: The WorkManager is used to schedule deferrable, asynchronous tasks that must be run reliably. • License: Apache 2.0 • **Dagger Hilt** • https://github.com/google/dagger • Purpose: Dependency injection framework. • License: Apache 2.0 • **Glide** • https://github.com/bumptech/glide • Purpose: Image loading and caching. • License: BSD, part MIT and Apache 2.0 • **kotlinx.collections.immutable** • https://github.com/Kotlin/kotlinx.collections.immutable • Purpose: Immutable collection interfaces and implementation prototypes for Kotlin. • License: Apache 2.0 • **kotlinx.coroutines** • https://github.com/Kotlin/kotlinx.coroutines • Purpose: Kotlin coroutines library for asynchronous and reactive code. • License: Apache 2.0 • **kotlinx.serialization** • https://github.com/Kotlin/kotlinx.serialization/ • Purpose: JSON serialization library for Kotlin. • License: Apache 2.0 • **OkHttp 3** • https://github.com/square/okhttp • Purpose: An HTTP client used by the library to intercept and log traffic. • License: Apache 2.0 • **Retrofit 2** • https://github.com/square/retrofit • Purpose: A networking layer interface. • License: Apac…