https://github.com/mcarr823/2fauth-compose

Android app for interacting with a self-hosted 2FAuth instance
https://github.com/mcarr823/2fauth-compose

android compose kotlin self-hosted

Last synced: about 1 month ago
JSON representation

Android app for interacting with a self-hosted 2FAuth instance

• Host: GitHub
• URL: https://github.com/mcarr823/2fauth-compose
• Owner: mcarr823
• License: gpl-3.0
• Created: 2023-09-20T05:12:52.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-30T01:35:07.000Z (6 months ago)
• Last Synced: 2024-10-03T12:18:05.283Z (3 months ago)
• Topics: android, compose, kotlin, self-hosted
• Language: Kotlin
• Homepage:
• Size: 286 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 2FAuth Compose

[![Android CI debug](https://github.com/mcarr823/2fauth-compose/actions/workflows/android.yml/badge.svg)](https://github.com/mcarr823/2fauth-compose/actions/workflows/android.yml)

2fauth-compose is an unofficial Android app for [2FAuth](https://docs.2fauth.app/).

This app connects to your self-hosted 2FAuth instance to generate 2fa tokens on your phone.

## Current state

- The API is written and mostly working/tested

- Unit tests have been written for most API requests

- Persistent storage is not yet supported

- UI is partially implemented, but needs further work

## Unit testing

In order to use or test this application, you will need an instance of 2FAuth setup somewhere.

For unit testing, or to speed up regular development/testing, you will need to update gradle.properties to include:

```

API_DOMAIN=http://my.domain.com

API_TOKEN=myapitoken

API_HTTPS_VERIFICATION=false

API_DEBUG_MODE=true

API_STORE_SECRETS=true

```

With values modified to suit your environment.