README.md

Casdoor Authenticator App

Casdoor Authenticator App is a cross-platform application for iOS, Android, and Web that provides multi-factor authentication using the TOTP protocol. This app helps secure user accounts by generating time-based one-time passwords (TOTP). The app is developed using React Native with Expo.

Features

• Multi-platform support (iOS/Android/Web)
• TOTP-based multi-factor authentication
• Account synchronization with Casdoor
• Web deployment via GitHub Pages
• Integration with Casdoor's central service and desktop client

Quick Start

git clone https://github.com/casdoor/casdoor-authenticator
cd casdoor-authenticator
npm install && npm run start

Installation

You can use the Casdoor Authenticator App in multiple ways:

• Web: Access the web version at https://casdoor.github.io/casdoor-authenticator (automatically deployed from master branch)
• Android: Download and install the APK file directly on your device from the GitHub Releases page

Building from Source

If you prefer to build the app yourself, follow these steps:

Common Steps

git clone https://github.com/casdoor/casdoor-authenticator
cd casdoor-authenticator
npm install

Android build

npm install && npx expo prebuild --platform android
cd android && ./gradlew assembleRelease

The APK file in the app/build/outputs/apk/release/ directory.

Web build

npm install
npm run export:web

The web build will be output to the dist/ directory.

Note: You'll need to have the necessary development environments set up for React Native, Android. Refer to the React Native documentation for detailed setup instructions.

Usage

• Open the app on your mobile device.
• Scan QR codes to add accounts and generate TOTP codes for login.
• Log in to your accounts for synchronization with Casdoor.

License

This project is licensed under the Apache-2.0 License. See the LICENSE file for details.