Merge pull request #1 from anexia/SIANXSVC-1224

SIANXSVC-1224: make runnable project, update readme

README.md

@@ -1,45 +1,51 @@
-# Open Source 2FAS for Android
+# Anexia Authenticator for Android
 
-This is the official Android app for the Open Source 2FAS project.
-
-## What is 2FAS?
-
-2FAS (Two-Factor Authentication Service) is a user authentication method that provides an additional layer of security for online accounts. In addition to a username and password, 2FAS uses a second factor, such as a one-time password (OTP) shown on a user's phone, to verify a user's identity. This helps prevent unauthorized access to accounts, even if a password is compromised.
+Anexia Authenticator is an open-source Time-based One-Time Password (TOTP) app designed to secure your online accounts. It generates time-sensitive codes that act as a second factor for your logins, significantly reducing the risk of unauthorized access. Anexia Authenticator is based on the project [2FAS Android](https://github.com/twofas/2fas-android).
 
 ## Features
 
 - Support for time-based one-time passwords (TOTP) and HMAC-based on-time passwords (HOTP)
-- Compatible with any service that supports the TOTP and HOTP standard, including Google, Microsoft, and Dropbox
-- Easy to set up and use
+- Compatible with any service that supports the TOTP and HOTP standard
 
-## Graphics
+## Installation
 
-Please note that the graphics used in this app are not part of the open source project and are subject to their own separate licensing terms.
+1. Download the app from the [play store](https://play.google.com/store/apps/details?id=at.anexia.authenticator).
+2. Install the app on your device.
+3. Follow the on-screen instructions to set up your online accounts.
 
-## Bug Reporting
+## Getting started
 
-We use GitHub for bug reports. Please visit the [2FAS for Android issues page](https://github.com/twofas/2fas-android/issues) to search for and report any bugs you may have found. Before adding a new issue, please search for existing issues to avoid duplicates.
+The following steps will help if you want to work on the application.
 
-For reporting security issues only, please send a detailed description of the vulnerability to [email protected]. Do not use this address for general inquiries or bug reports unrelated to security concerns.
+### Prerequirements
 
-## Getting Started
+- Android Studio Iguana
+- Android Version >= 6.0
+- Java 17
 
-1. Download the app from the [releases page](https://2fas.com).
-2. Install the app on your Android device.
-3. Follow the on-screen instructions to set up 2FAS for your online accounts.
+### Installation
+
+1. Clone the repository
+2. Create your own debug signing key in `config/debug_signing.jks`
+3. Create `config/config.properties` file with your debug key alias and password:
+```
+debug.storePassword=
+debug.keyAlias=
+debug.keyPassword=
+```
+4. Start working and debugging
+5. Run the app in Android Studio
 
 ## Contributing
 
-We welcome contributions to the Open Source 2FAS project. If you would like to contribute, please see the [contribution guide](./CONTRIBUTING.md).
+Contributions are welcome! 
+Because the project is a clone of the 2fas project, if you would like to contribute, please see [2FAS-Android](https://github.com/twofas/2fas-android) 
 
-## Donations
+## List of developers
 
-If you would like to support the development of the Open Source 2FAS project, you can [make a donation](https://2fas.com/donate). All donations will be used to support the ongoing development and maintenance of the project.
+- Bettina Kelhar <BKelhar@anexia-it.com>, Technical Leader Mobile
 
-We appreciate your support!
 
 ## License
 
-Copyright (c) Two Factor Authentication Service, Inc. All rights reserved.
-
-Licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).
+This project is published with the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).

app/build.gradle.kts

@@ -8,21 +8,19 @@ plugins {
     alias(libs.plugins.kotlinParcelize)
     alias(libs.plugins.kotlinKapt)
     alias(libs.plugins.ksp)
-    id("com.google.gms.google-services")
-    id("com.google.firebase.crashlytics")
 }
 
 android {
     namespace = "com.twofasapp"
 
     defaultConfig {
-        applicationId = "com.twofasapp"
-        versionName = "5.3.5"
-        versionCode = 5000017
+        applicationId = "at.anexia.authenticator"
+        versionName = "2.0.0"
+        versionCode = 20000
 
-        val versionCodeOffset = 5000000
+        val versionCodeOffset = 20000
 
-        archivesName.set("TwoFas-$versionName-${versionCode!! - versionCodeOffset}")
+        archivesName.set("AnxAuth-$versionName-${versionCode!! - versionCodeOffset}")
     }
 
     ksp {

app/src/main/java/com/twofasapp/App.kt

@@ -62,7 +62,7 @@ class App : Application() {
 
         cloudSyncWorkDispatcher.tryDispatch(CloudSyncTrigger.AppStart)
 
-        FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(sendCrashLogsPreference.get())
+        // FirebaseCrashlytics.getInstance().setCrashlyticsCollectionEnabled(sendCrashLogsPreference.get())
 
         try {
             SQLiteDatabase.loadLibs(this)

build.gradle.kts

@@ -2,9 +2,6 @@ buildscript {
     dependencies {
         classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${libs.versions.kotlin.get()}")
         classpath("org.jetbrains.kotlin:kotlin-serialization:${libs.versions.kotlin.get()}")
-        classpath("com.google.gms:google-services:4.4.0")
-        classpath("com.google.firebase:firebase-crashlytics-gradle:2.9.9")
-
     }
 }