Skip to content

akazwz/smail

Repository files navigation

Smail - 临时邮箱服务

一个基于 React Router v7 和 Cloudflare Workers 构建的现代化临时邮箱服务。

🌟 功能特性

  • 🚀 快速生成: 一键生成临时邮箱地址
  • 📧 实时接收: 即时接收和查看邮件
  • 🔒 隐私保护: 邮箱到期后自动删除数据
  • 📱 响应式设计: 完美适配桌面和移动设备
  • ⚡️ 无服务器架构: 基于 Cloudflare Workers,全球加速
  • 🗄️ 现代化技术栈: React Router v7、TypeScript、TailwindCSS
  • 📊 数据存储: 使用 Cloudflare D1 数据库和 R2 对象存储

🛠️ 技术栈

  • 前端: React Router v7, TypeScript, TailwindCSS
  • 后端: Cloudflare Workers, Email Workers
  • 数据库: Cloudflare D1 (SQLite)
  • 存储: Cloudflare R2 (附件存储)
  • ORM: Drizzle ORM
  • 邮件解析: postal-mime

🚀 快速开始

安装依赖

pnpm install

配置环境变量

复制环境变量示例文件并配置:

cp .dev.vars.example .dev.vars

编辑 .dev.vars 文件,设置必要的环境变量:

# 生成 Session 密钥
openssl rand -base64 32

# 将生成的密钥填入 .dev.vars 文件中的 SESSION_SECRET

设置数据库

# 生成数据库迁移文件
pnpm run db:generate

# 应用迁移到本地数据库
pnpm run db:migrate

启动开发服务器

pnpm dev

应用将在 http://localhost:5173 可用。

🧪 本地开发和测试

发送测试邮件

# 快速发送测试邮件
pnpm run test:email

# 发送自定义测试邮件(带附件)
pnpm run test:email:custom [收件人] [发件人] [端口] [是否包含附件]

# 例如:
pnpm run test:email:custom mytest@smail.pw sender@example.com 5173 true

数据库管理

# 查看迁移状态
pnpm run db:list

# 重置数据库(清空所有数据)
pnpm run db:reset

# 重新应用迁移
pnpm run db:migrate

详细的本地开发指南请查看:docs/local-development.md

📦 生产环境构建

创建生产构建:

pnpm run build

🚀 部署

直接部署到生产环境

pnpm run deploy

部署预览版本

pnpm wrangler versions upload

验证后可以将版本提升到生产环境:

pnpm wrangler versions deploy

部署前准备

  1. 配置 Cloudflare 服务:

    • 创建 D1 数据库:wrangler d1 create smail-database
    • 创建 KV 命名空间:wrangler kv namespace create "smail-kv"
    • 创建 R2 存储桶:wrangler r2 bucket create smail-attachments
    • 设置 Email Routing
  2. 配置 wrangler.jsonc: 复制 wrangler.example.jsonc 并填入你的资源ID:

    cp wrangler.example.jsonc wrangler.jsonc
    # 编辑 wrangler.jsonc,填入实际的ID
  3. 运行远程迁移:

    pnpm run db:migrate:remote

📂 项目结构

├── app/                    # 应用代码
│   ├── components/         # React 组件
│   ├── db/                 # 数据库相关
│   │   ├── migrations/     # 数据库迁移文件
│   │   └── schema.ts       # 数据库模式定义
│   ├── lib/                # 工具函数和数据库操作
│   └── routes/             # 路由组件
├── workers/                # Cloudflare Workers
│   └── app.ts              # Email Worker
├── scripts/                # 开发脚本
│   ├── test-email.js       # 邮件测试脚本
│   └── test-email.sh       # Shell 测试脚本
├── docs/                   # 文档
└── wrangler.jsonc          # Cloudflare 配置

🎨 样式

项目使用 Tailwind CSS 进行样式设计,支持:

  • 响应式设计
  • 暗色模式
  • 现代化 UI 组件
  • 自定义设计系统

🤝 贡献

欢迎贡献代码!请:

  1. Fork 项目
  2. 创建功能分支
  3. 提交更改
  4. 推送到分支
  5. 创建 Pull Request

📄 许可证

本项目采用 MIT 许可证。

🛟 支持

如有问题,请:


使用 ❤️ 和 React Router 构建。

About

Temporary email 临时邮箱 Cloudflare email

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •