diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..4a56edb4e3315c6fcb73f44fe2b44e2bea3b71a4 --- /dev/null +++ b/README.en.md @@ -0,0 +1,96 @@ +# Elysia Common Function Code + +This is an open-source project that provides general-purpose functions suitable for various application scenarios. + +## Features + +- Provides user management functionality +- Supports WebSocket communication +- Integrates database operations +- Includes middleware functionality +- Supports queue operations + +## Installation + +To use this project, please install the [Bun](https://bun.sh) runtime environment first. + +```bash +bun install +``` + +## Usage + +### User Application +```javascript +export default user_app; +``` + +### Database Connection +```javascript +export const db = drizzle(pool); +``` + +### Authorization Middleware +```javascript +export default Authorizator; +``` + +### Email Sending Function +```javascript +export async function sendVerifyCode(toEmail, code) { + return transporter.sendMail({ + from: '"Verification Code System" ', + to: toEmail, + subject: "Kuma Tech - Registration Verification Code", + text: "Kuma Tech", + html: `...` // HTML email content + }); +} +``` + +### Redis Scan Mode +```javascript +export default async function (pattern) { + try { + let cur = '0'; + let all_key = []; + + do { + let all_list = await redis_handler.scan(cur, { + MATCH: pattern, + COUNT: 100 + }); + cur = all_list.cursor; + + all_key = [...all_key, ...all_list.keys]; + + } while (cur !== '0'); + return all_key; + } catch (e) { + console.error(e); + } +} +``` + +### Security Middleware +```javascript +export default safe; +``` + +### Token Validation +```javascript +export default token_validate; +``` + +### Model Export +```javascript +export * from './fans_model.js'; +``` + +## Contributor Guide + +Code contributions and suggestions are welcome. Please read the project documentation first, then submit a PR or issue. + +## License + +This project uses the MIT License. For details, please see the LICENSE file in the project root directory. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..344cfa93bbfe8602c1dd5445904d2c7987ba7a70 --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ +# Elysia Common Function Code + +这是一个提供通用功能的开源项目,适用于各种应用场景。 + +## 功能特点 + +- 提供用户管理功能 +- 支持WebSocket通信 +- 集成数据库操作 +- 包含中间件功能 +- 支持队列操作 + +## 安装 + +要使用本项目,请先安装 [Bun](https://bun.sh) 运行环境。 + +```bash +bun install +``` + +## 使用方法 + +### 用户应用 +```javascript +export default user_app; +``` + +### 数据库连接 +```javascript +export const db = drizzle(pool); +``` + +### 授权中间件 +```javascript +export default Authorizator; +``` + +### 邮件发送功能 +```javascript +export async function sendVerifyCode(toEmail, code) { + return transporter.sendMail({ + from: '"验证码系统" ', + to: toEmail, + subject: "库玛科技-注册验证码", + text: `库玛科技`, + html: `...` // HTML邮件内容 + }); +} +``` + +### Redis扫描模式 +```javascript +export default async function (pattern) { + try { + let cur = '0' + let all_key = [] + + do { + let all_list = await redis_handler.scan(cur, { + MATCH: pattern, + COUNT: 100 + }); + cur = all_list.cursor; + + all_key = [...all_key, ...all_list.keys] + + } while (cur !== '0') + return all_key; + } catch (e) { + console.error(e) + } +} +``` + +### 安全中间件 +```javascript +export default safe; +``` + +### 令牌验证 +```javascript +export default token_validate; +``` + +### 模型导出 +```javascript +export * from './fans_model.js'; +``` + +## 贡献者指南 + +欢迎贡献代码和提出建议。请先阅读项目文档,然后提交PR或issue。 + +## 许可证 + +本项目采用 MIT 许可证。详情请查看项目根目录的 LICENSE 文件。 \ No newline at end of file