tristanbudd/2fa-debug-tool
GitHub: tristanbudd/2fa-debug-tool
一款基于 Next.js 的现代化应用程序,用于生成、验证和调试 TOTP 与 HOTP 双因素认证设置,支持二维码生成及特定提供商配置。
Stars: 0 | Forks: 0
Dark Mode Preview:
## 安装与项目设置
1. 克隆仓库
```
git clone https://github.com/tristanbudd/2fa-debug-tool.git
cd 2fa-debug-tool
```
2. 安装依赖(使用 pnpm)
```
pnpm install
```
3. 运行开发服务器
```
pnpm dev
```
在浏览器中打开 http://localhost:3000。
## 脚本
```
pnpm dev # Start Next.js in development mode
pnpm build # Build for production
pnpm start # Start the production server
pnpm lint # Run ESLint
pnpm lint:fix # Fix lint issues
pnpm format # Run Prettier to format files
pnpm format:check # Check formatting
pnpm typecheck # Run TypeScript type checking
pnpm prepare # Set up Husky git hooks
```
## 开发说明
- 本项目使用 Next.js 16、React 19、TypeScript 5 和 Tailwind CSS。
- Prettier 配置了 Tailwind 和导入排序插件。
- Husky pre-commit hook 在提交时运行 `pnpm lint && pnpm format:check && pnpm typecheck`。
## API 文档
- Markdown 参考:`docs/API.md`
- OpenAPI 3.1 JSON:`/api/openapi.json`
- 排除 `/api/og`(Open Graph 图像端点)
## 贡献指南
如果您想做出贡献,请阅读 `CONTRIBUTING.md` 并遵循以下通用准则:
1. Fork 仓库并为您的功能/修复创建一个分支。
2. 运行 `pnpm install` 并进行更改。
3. 保持提交的精简和专注;在适当的地方添加测试。
4. 确保格式化/检查在本地通过:`pnpm lint && pnpm format:check && pnpm typecheck`。
5. 打开一个 Pull Request,描述更改并关联相关问题。
## Issue 和 PR 模板
本仓库在 `.github/ISSUE_TEMPLATE` 和 `.github/PULL_REQUEST_TEMPLATE.md` 下包含模板,以帮助规范贡献内容。
## 安全
如果您发现安全漏洞,请开启一个私有 issue 并将其标记为敏感问题,或遵循 `SECURITY.md` 中的指引。
## 许可证
本项目在 MIT 许可证下获得许可,详情请参阅 `LICENSE` 文件。标签:2FA, Google Authenticator, HOTP, Microsoft Authenticator, OTP, otpauth, QA工具, QR Code, TOTP, TypeScript, 二维码, 双因素认证, 安全插件, 安全测试, 攻击性安全, 时间同步, 测试工具, 自动化攻击, 计数器, 验证码