https://github.com/josimon05/quickauth
A minimal 2FA Authenticator
https://github.com/josimon05/quickauth
2fa authenticator electron javascript minimal user-friendly windows
Last synced: 4 months ago
JSON representation
A minimal 2FA Authenticator
- Host: GitHub
- URL: https://github.com/josimon05/quickauth
- Owner: JoSimon05
- Created: 2024-08-13T22:40:30.000Z (almost 2 years ago)
- Default Branch: Latest
- Last Pushed: 2024-12-03T22:04:09.000Z (over 1 year ago)
- Last Synced: 2025-03-09T20:33:41.632Z (over 1 year ago)
- Topics: 2fa, authenticator, electron, javascript, minimal, user-friendly, windows
- Language: JavaScript
- Homepage:
- Size: 20.5 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 
QuickAuth
[](https://github.com/JoSimon05/QuickAuth/releases)
## DEMO
> **A minimal 2FA Authenticator that generate OTPs to easily access your accounts**
> *Demo relative to v1.0.0*
## WHAT IS 2FA?
**Two-Factor Authentication** (2FA) is a strong **security method** that requires two distinct forms of identification to access a websites (for example) and you can enable it in "Privacy and Security" section of your accounts.
Usually, websites you want to access send you a **6-digit code** via email or phone messages, but they often give you the opportunity to increase your account security level by enabling 2FA, using a **third-party app** (like **QuickAuth**) which generates a **new code every 30s** for each stored account.
> The "code" is called One Time Password (OTP) or Token in technical jargon
2FA apps require a **secret-key** to generate OTP and every website provides you with one in the form of a **QR code** or a **string** of letters and numbers.
> [!NOTE]
> **QuickAuth** can only accept secret-keys in string form (QR code scanner feature is under development...)
Here's an example of how to get a secret-key on Github:
## LOCAL STORAGE
All account secret-keys are stored inside a local database, sorted alphabetically (by name) and reloaded on application startup.
This allows you to use the app even offline and keep your data safe.
```json
"accounts": [
{
"name": "Discord",
"key": "YOURDISCORDSECRETKEY"
},
{
"name": "Epic Games",
"key": "YOUREPICGAMESSECRETKEY"
},
{
"name": "Github",
"key": "YOURGITHUBSECRETKEY"
}
]
```
## UPDATES
Updates are automatically checked and downloaded on startup, then you can choose wheter to install them immediately or at the next startup.
> [!NOTE]
> Even if you install new versions of the application, you won't lose your [stored data](https://github.com/JoSimon05/QuickAuth?tab=readme-ov-file#local-saves)
## USER-FRIENDLY
**QuickAuth** has been created to be as user-friendly as possible, It's simple to use and It allows you to access your accounts very quickly.
# Try QuickAuth!
**Check [Releases](https://github.com/JoSimon05/QuickAuth/releases) section and download the latest version available.**
> You just need to download this file: **QuickAuth_{version}_setup.exe**
> [!WARNING]
> Before installation by *installer.exe*, the system antivirus could show a security alert. DON'T WORRY! \
> You just need to click on "**More info**"
>
> 
>
> finally, click on the button "**Run anyway**" that appears next.
>
> 
>
> > That's because *authentication certificate* for native applications is missing yet (It's not that cheap...)
#### Please report any kind of problem or bug in the [Issues](https://github.com/JoSimon05/QuickAuth/issues) section.
## CREDITS (libraries)
[**speakeasy**](https://www.npmjs.com/package/speakeasy) - generates and verifies OTPs for 2FA
[**electron**](https://www.electronjs.org/) / [**electron-builder**](https://www.electron.build/index.html) / [**electron-updater**](https://www.electron.build/auto-update.html) - make the application functional and updatable