MyAuthenticator - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #go #deep-learning #linux #nodejs #java #windows #kubernetes #awesome-list #vue #security #openai #open-source

MyAuthenticator

(★ 73)

A serverless progressive web application that generates TOTP and HOTP codes, enabling robust two-factor authentication (2FA) directly within your browser. Powered by Nuxt 4, NuxtHub, NuxtUI 3, Cloudflare Pages, D1 Database, and Drizzle ORM.

파일 탐색기

최종 버전 다운로드 (.zip)

- - Add.vue
  - BackupAndRestore.vue
  - BottomBar.vue
  - Edit.vue
  - Form.vue
  - Menu.vue
  - Passkeys.vue
  - Qrscan.vue
  - Search.vue
  - Share.vue
  - ThemePicker.vue
  - ThemePickerButton.vue
  - Tile.vue
- - auth.ts
- - index.vue
  - login.vue
- - theme.ts
- app.config.ts
- app.vue
- - 1.jpg
  - 2.jpg
  - 3.jpg
  - 4.jpg
  - 5.jpg
  - 6.jpg
  - landscape.png
- favicon-16x16.png
- favicon.ico
- logo.png
- pwa-192x192.png
- pwa-512x512.png
- robots.txt
- - schema.ts
- - drizzle.ts
- tsconfig.json
- - index.ts
- - aes.ts
  - constants.ts
  - index.ts
.gitignore
.npmrc
.nvmrc
drizzle.config.ts
eslint.config.mjs
nuxt.config.ts
package.json
pnpm-lock.yaml
README.md
tsconfig.json

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/IAMSDR/MyAuthenticator

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd MyAuthenticator

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
<img src="./public/logo.png" width="300px" alt="logo" />
</div>
<h1 align="center">MyAuthenticator</h1>
<p align="center">A serverless progressive web application that generates TOTP and HOTP codes, offering robust two-factor authentication (2FA) directly within your browser.</p>

<div align="center">
  
[![Nuxt 4 Badge](https://img.shields.io/badge/Nuxt_4-black?style=for-the-badge&logo=nuxt&link=https%3A%2F%2Fnuxt.com)](https://nuxt.com)
[![NuxtHub Badge](https://img.shields.io/badge/NuxtHub-black?style=for-the-badge&logo=nuxt&link=https%3A%2F%2Fnuxt.com)](https://hub.nuxt.com)
[![NuxtUi Badge](https://img.shields.io/badge/Nuxtui_3-black?style=for-the-badge&logo=nuxt&link=https%3A%2F%2Fnuxt.com)](https://ui.nuxt.com)
[![Cloudflare Pages Badge](https://img.shields.io/badge/Cloudflare_Pages-black?style=for-the-badge&logo=cloudflarepages&link=https%3A%2F%2Fpages.cloudflare.com)](https://pages.cloudflare.com)
[![Typescript Badge](https://img.shields.io/badge/Typescript-black?style=for-the-badge&logo=typescript&link=https%3A%2F%2Fwww.typescriptlang.org)](https://www.typescriptlang.org)
[![Drizzle Badge](https://img.shields.io/badge/Drizzle-black?style=for-the-badge&logo=drizzle&link=https%3A%2F%2Fdrizzle.com)](https://drizzle.com)
[![Tailwindcss Badge](https://img.shields.io/badge/Tailwindcss_4-black?style=for-the-badge&logo=tailwindcss&link=https%3A%2F%2Ftailwindcss.com)](https://tailwindcss.com)

</div>

## Live Demo

[![Demo Site](https://img.shields.io/badge/Demo-Visit-blue?style=for-the-badge&logo=googlechrome)](https://my-authenticator.pages.dev)

- Credentials: `admin` - `Admin@123$`

## Deploy 🚀

[![Deploy to NuxtHub](https://hub.nuxt.com/button.svg)](https://hub.nuxt.com/new?repo=IAMSDR/MyAuthenticator)

> [!NOTE]
> This project is currently under testing and improvements. Please back up your data before proceeding.

You can deploy this project on your Cloudflare account for **free** with zero configuration using **[NuxtHub](https://hub.nuxt.com)**. You can use either the NuxtHub CLI or the NuxtHub Admin Web UI. Simply select your GitHub account, set the required environment variables, and you're done. You now have your own authenticator.

## Features 🔥

**🚀 Serverless:** Fully leverages edge support, eliminating the need for server maintenance. Deploy on Cloudflare Pages for _free_.

**⚙️ Compatibility:** Supports `TOTP` (Time-Based One-Time Password) and `HOTP` (HMAC-Based One-Time Password), widely used for two-factor authentication.

**☀️ Theming:** Built with Nuxt UI v3, offering light and dark themes with customizable accent colors and more.

**💫 Icons:** Fetches icons directly from [Iconify](https://iconify.design/), providing a vast collection from various icon sets.

**🔐 Secure:** Utilizes `nuxt-auth-utils` for authentication, supports passkeys for secure access, and encrypts database fields for enhanced security.

**🗃️ Backup / Restore:** Securely backup and restore authenticators with encryption seamlessly.

## Screenshots 📱

<p>
  <img src='./public/screenshots/1.jpg' height="690"/>
  <img src='./public/screenshots/2.jpg' height="690"/>
  <img src='./public/screenshots/3.jpg' height="690"/>
  <img src='./public/screenshots/4.jpg' height="690"/>
  <img src='./public/screenshots/5.jpg' height="690"/>
  <img src='./public/screenshots/6.jpg' height="690"/>
</p>

## Environment Variables

```sh
# required
NUXT_SESSION_PASSWORD="your-32-char-super-long-secret-for-session-encryption"
NUXT_AUTH_USERNAME="admin"
NUXT_AUTH_PASSWORD="Admin@123$"

# optional
NUXT_DB_ENCRYPTION_PASSWORD="your-32-char-super-long-secret-for-db-encryption"
```

### Required Variables

- `NUXT_SESSION_PASSWORD`: This password is used by `nuxt-auth-utils` to secure your session. It must be at least 32 characters long.

- `NUXT_AUTH_USERNAME`: The username for authentication. It must be at least 5 characters long.

- `NUXT_AUTH_PASSWORD`: The password for authentication. It must be at least 8 characters long and include:
  - One uppercase letter
  - One digit
  - One lowercase letter
  - Two special characters

### Optional Variables

- `NUXT_DB_ENCRYPTION_PASSWORD`: This password is used to encrypt and decrypt the database field of `secretkey`. By default, no encryption is used for data stored in the database. You can enable encryption by setting this variable. `It must be exactly 32 characters long`.

## Contributing and Suggestions

Feel free to contribute to this project with your ideas and improvements. Your feedback and suggestions are highly valued and will help enhance this project further.

## License

MyAuthenticator is Free Software: You can use, study, share, and improve it at your will. Specifically, you can redistribute and/or modify it under the terms of the [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.en.html) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.