feat: update readme

2026-09-07 08:27:08 +08:00 · 2023-08-29 22:21:35 +08:00
parent c4bb3a2fdd
commit 1b385ccfbf
7 changed files with 162 additions and 32 deletions
@@ -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)