anypass-kmp - GitLite

KO | EN

gitlite — search

#hacktoberfest #go #android #machine-learning #rust #macos #windows #cli #kubernetes #vue #awesome-list #pytorch #security #open-source

anypass-kmp

(★ 270)

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

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - feature_request.md
- - android-pr.yml
  - android.yml
- build.gradle.kts
- google-services.json
- proguard-rules.pro
- - build.gradle.kts
- gradle.properties
- settings.gradle.kts
- - admob.podspec
  - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- - authManager.podspec
  - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- libs.versions.toml
- - ContentView.swift
  - Info.plist
  - iOSApp.swift
- - project.pbxproj
- Config.xcconfig
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- account.png
- add_new_password.png
- authenticator.png
- change_key_password.png
- confirm_key_password.png
- generate_password.png
- help.png
- home.png
- password_health.png
- rounded-banner.png
- sign_in.png
- sign_up.png
- google-services.gpg
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
  - images.podspec
- - build.gradle.kts
- cleanup-secrets.sh
- cleanup.sh
- decrypt-and-save.sh
- rebuild.sh
- build.gradle.kts
- shared.podspec
- anypass-copyright.txt
.editorconfig
.gitignore
build.gradle.kts
CONTRIBUTING.md
gradle.properties
gradlew
gradlew.bat
LICENSE
local.properties
README.md
settings.gradle.kts

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <a href="https://github.com/getspherelabs/anypass-kmp"><img  alt="AnyPass Banner" src="https://github.com/getspherelabs/anypass-kmp/blob/main/media/rounded-banner.png?raw=true"/></a>
</p>

<p align="center">
<a href="">
    <img src="https://img.shields.io/badge/Kotlin-1.9.0-blue.svg?style=flat&logo=kotlin">
</a>
<a href="">
    <img src="https://img.shields.io/badge/iOS-14.0%2B-green">
</a>
<a href="">
    <img src="https://img.shields.io/badge/Swift-5-F16D39.svg?style=flat">
</a>
<a href="">
    <img src="http://img.shields.io/badge/platform-android-6EDB8D.svg?style=flat">
</a>
</a>
<a href="">
    <img src="http://img.shields.io/badge/platform-ios-EAEAEA.svg?style=flat">
</a>
</p>

# AnyPass

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

## Download

<a href="https://play.google.com/store/apps/details?id=io.spherelabs.anypass.android" target="_blank">
<img src="https://play.google.com/intl/en_gb/badges/static/images/badges/en_badge_web_generic.png" width=240 />
</a>

# 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

<p align="center">
  <img src="media/sign_in.png" width="150" alt="SignIn Screen"/>
  <img src="media/sign_up.png" width="150" alt="SignUp Screen"/>
  <img src="media/confirm_key_password.png" width="150" alt="ConfirmKeyPassword Screen"/>
  <img src="media/home.png" width="150" alt="Home Screen"/>
  <img src="media/add_new_password.png" width="150" alt="Add new password Screen"/>
  <img src="media/generate_password.png" width="150" alt="GeneratePassword Screen"/>
  <img src="media/account.png" width="150" alt="Account Screen"/>
  <img src="media/authenticator.png" width="150" alt="Authenticator Screen"/>
  <img src="media/password_health.png" width="150" alt="PasswordHealth Screen"/>
  <img src="media/help.png" width="150" alt="Help Screen"/>
</p>

# Technology

- [Kotlin](https://kotlinlang.org)
- [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform)
- [Kotlin Coroutine](https://kotlinlang.org/docs/coroutines-overview.html)
- [Swift](https://www.swift.org)
- [SqlDelight](https://github.com/cashapp/sqldelight)
- [Koin](https://insert-koin.io)
- [Meteor](https://github.com/getspherelabs/meteor-kmp)
- [Firebase](https://firebase.google.com)
- [Sentry](https://sentry.io)
- [Google Admob](https://admob.google.com)
- [Multiplatform Settings](https://github.com/russhwolf/multiplatform-settings)
- [Moko Resource](https://github.com/icerockdev/moko-resources)
- [Sentry Multiplatform](https://docs.sentry.io/platforms/kotlin-multiplatform)
- [BuildKonfig](https://github.com/yshrsmz/BuildKonfig)
- [Coil](https://github.com/coil-kt/coil)
- [Meteor ViewModel](https://github.com/getspherelabs/meteor-kmp)
- [Turbine](https://github.com/cashapp/turbine)
- [Ktlint](https://github.com/pinterest/ktlint)
- [Spotless](https://github.com/diffplug/spotless)
- [Jacoco](https://github.com/jacoco/jacoco)
- [AssertK](https://github.com/willowtreeapps/assertk)
- [Konsist](https://github.com/LemonAppDev/konsist)
- [Lyricist](https://github.com/adrielcafe/lyricist)
- [Uri-kmp](https://github.com/eygraber/uri-kmp)
- [Test-logger](https://github.com/radarsh/gradle-test-logger-plugin)
- [CameraX](https://developer.android.com/jetpack/androidx/releases/camera)
- [MLKit](https://developers.google.com/ml-kit)

# 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:
```mermaid
graph TD;
    core-->common;
    core-->designsystem;
    core-->analytics;
    designsystem-->shared;
    common-->shared;
    analytics-->shared;
```

### Manager Module:

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

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

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

### Data Module:

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

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

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

### Feature Module:

```mermaid
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;
```

# 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.

> :warning: 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](/CONTRIBUTING.md)** [![Fork AnyPass](https://img.shields.io/github/forks/getspherelabs/anypass-kmp?logo=github&style=social)](https://github.com/getspherelabs/anypass-kmp/fork)

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

<table>
  <tbody>
    <tr>
       <td align="center">
        <a href="https://github.com/behzodhalil">
          <img src="https://avatars.githubusercontent.com/u/72313937?v=4" width="100" alt="Behzod Halil">
        </a>
        <br>
        <a href="https://github.com/behzodhalil">Behzod Halil</a>
      </td>
      <td align="center">
        <a href="https://github.com/oybekjon94">
          <img src="https://avatars.githubusercontent.com/u/91370134?v=4" width="100" alt="John Doe">
        </a>
        <br>
        <a href="https://github.com/oybekjon94">Oybek Kholiqov</a>
      </td>
      <td align="center">
        <a href="https://github.com/khurshiddev">
          <img src="https://avatars.githubusercontent.com/u/92572647?v=4" width="100" alt="Jane Smith">
        </a>
        <br>
        <a href="https://github.com/khurshiddev">Khurshid Usarov</a>
      </td>
        <td align="center">
        <a href=" https://github.com/sardor-m">
          <img src="https://avatars.githubusercontent.com/u/65296404?v=4" width="100" alt="Jane Smith">
        </a>
        <br>
        <a href="https://github.com/sardor-m">Sardor-M</a>
      </td>
      
    </tr>
  </tbody>
</table>

## Project Requirements

- Java 17+
- iOS: 14.0+