zmail/README.en.md

🚀 ZMAIL - 24-hour Temporary Email Service

English | 中文

If you find this project helpful, please consider giving it a ⭐️ Star ⭐️. Your support is greatly appreciated!

💌 Secure, Simple, Disposable Email Service

🌐 Live Demo • ✨ Features • 🚀 Deployment • 💻 Development • 🔧 Tech Stack

---

📹 Video Tutorial

📺 The complete video tutorial covers:

1. Project introduction and feature demonstration
2. Detailed steps for frontend deployment to Cloudflare Pages
3. Detailed steps for backend deployment to Cloudflare Workers
4. Configuring Cloudflare Email routing
5. Setting up environment variables and database

👉 Click here to watch the full tutorial

---

✨ Features

✨ Instant Creation

Get a temporary email address instantly, no registration required

🔒 Privacy Protection

Protect your real email from spam and data leaks

⚡ Real-time Reception

Receive emails in real-time without refreshing the page

🌐 Global Availability

Built on Cloudflare's global edge network for fast access worldwide

🔄 Auto-refresh

Automatically check for new emails, never miss important messages

📱 Responsive Design

Perfect fit for all devices, from mobile to desktop

---

🚀 Quick Deployment

ZMAIL consists of two parts that need to be deployed separately, deploy the backend first, then the frontend:

⚙️ Backend Deployment

2️⃣ Deploy Backend to Cloudflare Workers

1. Click the "Deploy to Cloudflare Workers" button
2. Connect your GitHub account and select this repository
3. Configure build settings:
   • Deploy command: yarn deploy
   • Advanced settings -> Root directory: /worker
4. Configure D1 database:
   • Create a D1 database (e.g., mail_db)
   • Bind it to your Worker (binding name: DB)
5. Configure Email routing:
   • Set up Email routing in the Cloudflare dashboard to forward emails to your Worker
   • If you want to configure multiple domain emails, set up email forwarding for each domain to the worker in the CloudFlare dashboard
6. Click "Deploy"

---

🖥️ Frontend Deployment

1️⃣ Deploy Frontend to Cloudflare Pages

1. Click the "Deploy to Cloudflare Pages" button
2. Connect your GitHub account and select this repository
3. Configure build settings:
   • Build command: yarn build
   • Build output directory: dist
   • Root directory (Advanced) -> Path: frontend
4. Configure environment variables:
   • VITE_API_BASE_URL: Your Worker API base URL (e.g., https://api.mdzz.uk)
   • VITE_EMAIL_DOMAIN: Your domain list, separated by ',' (e.g., mdzz.uk,zaunist.com)
5. Click "Save and Deploy"

---

💻 Local Development

🎨 Frontend Development

# Navigate to frontend directory
cd frontend

# Install dependencies
yarn install

# Start development server
yarn dev

⚙️ Worker Development

# Navigate to worker directory
cd worker

# Install dependencies
yarn install

# Build preview
yarn build

# Deploy to Cloudflare
yarn deploy

---

🔧 Tech Stack

🎨 Frontend

• React - UI library
• TypeScript - Type-safe JavaScript
• Tailwind CSS - Utility-first CSS framework
• Vite - Modern frontend build tool

⚙️ Backend

• Cloudflare Workers - Edge computing platform
• Cloudflare D1 - Edge SQL database
• Cloudflare Email Workers - Email processing service

---

👥 Contributing

Contributions via Pull Requests or Issues are welcome!

⭐ Support This Project

If this project has been helpful to you, or if you like it, please give it a Star ⭐️

Your support motivates me to make continuous improvements!

📄 License

MIT License