https://github.com/crazymryan/easy-verify

一个 Nodejs + Redis 的邮箱验证码+验证服务，易移植，易使用。
https://github.com/crazymryan/easy-verify

code email email-sender mail mail-code nodejs redis verify-email verifycode

Last synced: 2 months ago
JSON representation

一个 Nodejs + Redis 的邮箱验证码+验证服务，易移植，易使用。

• Host: GitHub
• URL: https://github.com/crazymryan/easy-verify
• Owner: CrazyMrYan
• License: mit
• Created: 2024-05-19T13:47:17.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-23T03:24:53.000Z (8 months ago)
• Last Synced: 2024-10-17T12:33:21.200Z (3 months ago)
• Topics: code, email, email-sender, mail, mail-code, nodejs, redis, verify-email, verifycode
• Language: JavaScript
• Homepage:
• Size: 199 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# EasyVerify

![GitHub License](https://img.shields.io/github/license/CrazyMrYan/easy-verify)

![GitHub Tag](https://img.shields.io/github/v/tag/CrazyMrYan/easy-verify)

![GitHub last commit](https://img.shields.io/github/last-commit/CrazyMrYan/easy-verify)

![GitHub package.json version](https://img.shields.io/github/package-json/v/CrazyMrYan/easy-verify)

![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr/CrazyMrYan/easy-verify)

EasyVerify 是一个基于 Node.js 和 Redis 的开源邮件验证码服务，提供发送和校验验证码的功能。

![preview](./assets/code-verify.png)

## 功能

- 生成并发送验证码到指定邮箱

- 验证用户输入的验证码是否正确

- 可配置的验证码有效期

## 配置

在根目录创建一个 .env.local 环境变量，配置以下内容

```env

EMAIL_SERVICE=

EMAIL_USERNAME=

EMAIL_PASSWORD=

EMAIL_SEND_NAME=

REDIS_HOST=127.0.0.1

REDIS_PORT=6379

PORT=3000

CODE_EXPIRE_TIME=120

```

## 使用

```shell

cd verify-code

yarn install

```

## 启动

```shell

yarn dev

```

## API 文档

### 1. 发送验证码

请求

方法：POST

路径：/send-code

参数：

- email (string): 接收验证码的邮箱地址

- username (string): 用户名称（非必填）

示例

```bash

curl -X POST http://localhost:3000/send-code -d "[email protected]"

```

### 2. 校验验证码

请求

方法：POST

路径：/verify-code

参数：

email (string): 接收验证码的邮箱地址

code (string): 用户输入的验证码

示例

```bash

curl -X POST http://localhost:3000/verify-code -d "[email protected]&code=123456"

```

## 贡献

欢迎贡献代码！请提交 Pull Request 或报告问题到 issues。

## 许可证

本项目使用 MIT 许可证。请参阅 LICENSE 文件了解更多信息。