feat: update readme

README.md

@@ -1,70 +1,131 @@
-# cloudflare temp email
+# 使用 cloudflare 免费服务，搭建临时邮箱
 
-利用 Cloudflare Workers 创建临时邮箱
+## [English](README_EN.md)
 
-- 使用 Cloudflare Pages 部署前端
+## [在线演示](https://temp-email.dreamhunter2333.xyz/)
-- 使用 Cloudflare Workers 部署后端
-- email 转发使用 Cloudflare Email Route
-- Cloudflare D1 作为数据库。
-- 免费版附件过大会造成 Exceeded CPU Limit 错误
 
-[在线演示](https://temp-email.dreamhunter2333.xyz/)
+## 功能/TODO
 
-This is a temporary email service that uses Cloudflare Workers to create a temporary email address and view the received email in web browser.
+- [x] Cloudflare D1 作为数据库
+- [x] 使用 Cloudflare Pages 部署前端
+- [x] 使用 Cloudflare Workers 部署后端
+- [x] email 转发使用 Cloudflare Email Routing
+- [ ] 免费版附件过大会造成 Exceeded CPU Limit 错误
 
-[Live Demo](https://temp-email.dreamhunter2333.xyz/)
+---
 
-![demo](readme_assets/demo.png)
+## 什么是临时邮箱
 
-## Deploy
+临时邮箱，也被称为一次性邮箱或临时邮件地址，是一种用于临时接收邮件的虚拟邮箱。与常规邮箱不同，临时邮箱旨在提供一种匿名且临时的邮件接收解决方案。
 
-[Install/Update Wrangler](https://developers.cloudflare.com/workers/wrangler/install-and-update/)
+临时邮箱往往由网站或在线服务提供商提供，用户可以在需要注册或接收验证邮件时使用临时邮箱地址，而无需暴露自己的真实邮箱地址。这样做的好处是可以保护个人隐私
 
-## DB - Cloudflare D1
+---
+
+## Cloudflare 服务
+
+- `D1` 是 `Cloudflare` 的原生无服务器数据库。
+- `Pages` 是 `Cloudflare` 的静态网站托管服务, 速度超快，始终保持最新状态。
+- `Workers` 是 `Cloudflare` 的 `serverless` 应用服务，可以在全球 300 个数据中心运行代码, 而无需配置或维护基础架构。
+- `Cloudflare Email Routing` 可以处理域名的所有电子邮件流量，而无需管理电子邮件服务器。
+
+---
+
+## wrangler 的安装
+
+安装 wrangler
 
 ```bash
-# create a database, and copy the output to wrangler.toml in the next step
+npm install wrangler -g
+```
+
+---
+
+## D1 数据库
+
+第一次执行登录 wrangler 命令时，会提示登录, 按提示操作即可
+
+```bash
+# 创建 D1 并执行 schema.sql
 wrangler d1 create dev
 wrangler d1 execute dev --file=db/schema.sql
 ```
 
-![d1](readme_assets/d1.png)
+创建完成后，我们在 cloudflare 的控制台可以看到 D1 数据库
 
-### Backend - Cloudflare workers
+![D1](readme_assets/d1.png)
+
+---
+
+## Cloudflare workers 后端
+
+初始化项目
 
 ```bash
 cd worker
 pnpm install
-# copy wrangler.toml.template to wrangler.toml
-# and add your d1 config and these config
-# PREFIX = "tmp" - the email create will be like tmp<xxxxx>@DOMAIN
-# DOMAIN = "xxx.xxx" - you domain name
-# JWT_SECRET = "xxx"
-# BLACK_LIST = ""
 cp wrangler.toml.template wrangler.toml
-# deploy
+```
+
+修改 `wrangler.toml` 文件
+
+```bash
+name = "cloudflare_temp_email"
+main = "src/worker.js"
+compatibility_date = "2023-08-14"
+node_compat = true
+
+[vars]
+PREFIX = "tmp" # 要处理的邮箱名称前缀
+DOMAIN = "xxx.xxx" # 你的域名
+JWT_SECRET = "xxx" # 用于生成 jwt 的密钥
+BLACK_LIST = "" # 黑名单，用于过滤发件人，逗号分隔
+
+[[d1_databases]]
+binding = "DB"
+database_name = "xxx" # D1 数据库名称
+database_id = "xxx" # D1 数据库 ID
+```
+
+---
+
+## Cloudflare Workers 后端
+
+部署
+
+```bash
 pnpm run deploy
 ```
 
-you can find and test the worker's url in the  workers dashboard
+部署成功之后再路由中可以看到 `worker` 的 `url`，控制台也会输出 `worker` 的 `url`
 
 ![worker](readme_assets/worker.png)
 
-enable email route and config email forward catch-all to the worker
+---
 
-![email](readme_assets/email.png)
+## Cloudflare Pages 前端
-
-### Frontend - Cloudflare pages
 
 ```bash
 cd frontend
 pnpm install
-# add .env.local and modify VITE_API_BASE to your worker's url
-# VITE_API_BASE=https://xxx.xxx.workers.dev - don't put / in the end
 cp .env.example .env.local
+```
+
+修改 `.env.local` 文件, 将 `VITE_API_BASE` 修改为 `worker` 的 `url`, 不要在末尾加 `/`
+
+例如: `VITE_API_BASE=https://xxx.xxx.workers.dev`
+
+```bash
 pnpm build --emptyOutDir
-cd ..
+# 根据提示创建 pages
 pnpm run deploy
 ```
 
 ![pages](readme_assets/pages.png)
+
+## 参考资料
+
+- https://developers.cloudflare.com/d1/
+- https://developers.cloudflare.com/pages/
+- https://developers.cloudflare.com/workers/
+- https://developers.cloudflare.com/email-routing/

README_EN.md

@@ -0,0 +1,69 @@
+# cloudflare temp email
+
+## [中文](README.md)
+
+## [Live Demo](https://temp-email.dreamhunter2333.xyz/)
+
+This is a temporary email service that uses Cloudflare Workers to create a temporary email address and view the received email in web browser.
+
+## Features
+
+- [x] Cloudflare D1 as a database
+- [x] Deploy the front end with Cloudflare Pages
+- [x] Deploy the backend with Cloudflare Workers
+- [x] Email forwarding using Cloudflare Email Routing
+- [ ] Exceeded CPU Limit error caused by the free version of the attachment
+
+![demo](readme_assets/demo.png)
+
+## Deploy
+
+[Install/Update Wrangler](https://developers.cloudflare.com/workers/wrangler/install-and-update/)
+
+## DB - Cloudflare D1
+
+```bash
+# create a database, and copy the output to wrangler.toml in the next step
+wrangler d1 create dev
+wrangler d1 execute dev --file=db/schema.sql
+```
+
+![d1](readme_assets/d1.png)
+
+### Backend - Cloudflare workers
+
+```bash
+cd worker
+pnpm install
+# copy wrangler.toml.template to wrangler.toml
+# and add your d1 config and these config
+# PREFIX = "tmp" - the email create will be like tmp<xxxxx>@DOMAIN
+# DOMAIN = "xxx.xxx" - you domain name
+# JWT_SECRET = "xxx"
+# BLACK_LIST = ""
+cp wrangler.toml.template wrangler.toml
+# deploy
+pnpm run deploy
+```
+
+you can find and test the worker's url in the  workers dashboard
+
+![worker](readme_assets/worker.png)
+
+enable email route and config email forward catch-all to the worker
+
+![email](readme_assets/email.png)
+
+### Frontend - Cloudflare pages
+
+```bash
+cd frontend
+pnpm install
+# add .env.local and modify VITE_API_BASE to your worker's url
+# VITE_API_BASE=https://xxx.xxx.workers.dev - don't put / in the end
+cp .env.example .env.local
+pnpm build --emptyOutDir
+pnpm run deploy
+```
+
+![pages](readme_assets/pages.png)