qomg/anypass-kmp

AnyPass: A Compose Multiplatform app for your all-in-one password manager

AnyPass

AnyPass is your one-stop solution for password management, password generation, and password health analysis.

Download

Architecture

The app architecture has three layers: a data layer, a domain layer and a UI layer. AnyPass uses Meteor KMP to create application using MVI architecture. It provides a unidirectional data flow (UDF), allowing you to handle state changes and propagate them to the UI efficiently.

Single source of truth

When a new data type is defined in your app, you should assign a Single Source of Truth (SSOT) to it. The SSOT is the owner of that data, and only the SSOT can modify or mutate it. To achieve this, the SSOT exposes the data using an immutable type, and to modify the data, the SSOT exposes functions or receive events that other types can call.

This pattern brings multiple benefits:

• It centralizes all the changes to a particular type of data in one place.
• It protects the data so that other types cannot tamper with it.
• It makes changes to the data more traceable. Thus, bugs are easier to spot.

In an offline-first application, the source of truth for application data is typically a database. In some other cases, the source of truth can be a ViewModel or even the UI.

Screenshots

Technology

• Kotlin
• Compose Multiplatform
• Kotlin Coroutine
• Swift
• SqlDelight
• Koin
• Meteor
• Firebase
• Sentry
• Google Admob
• Multiplatform Settings
• Moko Resource
• Sentry Multiplatform
• BuildKonfig
• Coil
• Meteor ViewModel
• Turbine
• Ktlint
• Spotless
• Jacoco
• AssertK
• Konsist
• Lyricist
• Uri-kmp
• Test-logger
• CameraX
• MLKit

Modularization

Modularization is the practice of breaking the concept of a monolithic, one-module codebase into loosely coupled, self contained modules.

A barebone module is simply a directory with a Gradle build script inside. Usually though, a module will consist of one or more source sets and possibly a collection of resources or assets. Modules can be built and tested independently. Due to Gradle's flexibility there are few constraints as to how you can organize your project. In general, you should strive for low coupling and high cohesion.

• Low coupling - Modules should be as independent as possible from one another, so that changes to one module have zero or minimal impact on other modules. They should not possess knowledge of the inner workings of other modules.
• High cohesion - A module should comprise a collection of code that acts as a system. It should have clearly defined responsibilities and stay within boundaries of certain domain knowledge.

Core Module:

graph TD;
    core-->common;
    core-->designsystem;
    core-->analytics;
    designsystem-->shared;
    common-->shared;
    analytics-->shared;

Loading

Manager Module:

graph TD;
    manager-->password;
    manager-->biometry;

    password-->features;
    biometry-->features;

    features-->generatepassword;
    features-->account;

Loading

Data Module:

graph TD;
    data-->local;
    data-->authManager;
    data-->prefs;

    features-->onboarding;
    features-->auth;
    features-->addnewpassword;
    features-->home;

    prefs--> features;
    local-->features;
    authManager-->features;

Loading

Feature Module:

graph TD;
    features-->onboarding;
    features-->auth;
    features-->addnewpassword;
    features-->home;
    features-->auth;
    features-->account;
    features-->generatepassword;

    onboarding-->shared;
    auth-->shared;
    home-->shared;
    addnewpassword-->shared;
    account-->shared;
    generatepassword-->shared;

Loading

Setup

1. Check your Xcode version is 14.1 or newer. Additionally, check your Android Studio version is Flamingo or newer.

2. Clone the repository using the following command:

   https://github.com/getspherelabs/anypass-kmp.git
   

3. When building the iOS app, you may face common issues:

   • Issue: Unicode Normalization not appropriate for ASCII-8BIT

   • Solution: Try add your ~/.zprofile, ~/.zshrc files:

      LANG=en_US.UTF-8
      LANGUAGE=en_US.UFT-8
      LC_ALL=en_US.UFT-8
     

   • Issue: Sometimes you can not build your iOS app from Xcode

   • Solution: Follow these steps after executing the cleanup script:

     1. pod deintegrate
     2. pod init
     3. Copy the pod modules
     4. pod install

4. Build and run the app on your Android / iOS device or simulator.

⚠️ Make fake google-services.json for building properly.

5. We recommend including linkers from Xcode. To include linkers from Xcode, follow these steps:

   1. Navigate to iosApp/Build Settings/Linking.
   2. Add the following linkers to your Other Linking Flags:
      • lsqlite3
      • ObjC

Screenshots

Contributers

Want to contribute? See CONTRIBUTING.md

Those are the list of contributors of this project, thanks for your contribution 🧑‍💻:**

Behzod Halil

Oybek Kholiqov

Khurshid Usarov

Sardor-M

Project Requirements

• Java 17+
• iOS: 14.0+