casdoor
/
casdoor-app
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: add README (#8) 

Signed-off-by: BSS ZU <274620705z@gmail.com>
This commit is contained in:
IZUMI-Zu 2024-07-05 20:41:38 +08:00 committed by GitHub
parent 0a237c9bc3
commit fa8fba4477
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1 +1,28 @@
# casdoor-app
# Casdoor Authenticator App
Casdoor Authenticator App is a mobile application for iOS and Android 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 the React Native framework.
## Features
- [x] Multi-platform support (iOS/Android)
- [x] TOTP-based multi-factor authentication
- [ ] Account synchronization with Casdoor
- [ ] Integration with Casdoor's central service and desktop client
## Quick Start
```bash
git clone git@github.com:casdoor/casdoor-app.git
cd casdoor-app
npm install && npm run start
```
## 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. (In progress)
## License
This project is licensed under the Apache-2.0 License. See the [LICENSE](./LICENSE) file for details.