Skip to content

README.md

Latest commit

 

History

History
110 lines (83 loc) · 4.35 KB

README.md

File metadata and controls

110 lines (83 loc) · 4.35 KB

📬 Open-Temp-Mail

Deploy to Cloudflare Workers Open in GitHub Codespaces License Version Status

Open-Temp-Mail is a modern, high-performance temporary email service built for speed, privacy, and ease of deployment. Engineered with React, Vite, and Cloudflare Workers, it provides a seamless disposable email experience with a premium UI.

✨ Features

  • 🚀 Blazing Fast: Powered by Cloudflare Workers for edge-latency global performance.
  • 🛡️ Privacy First: Completely anonymous and disposable inboxes.
  • 🎨 Stunning UI: A beautiful, dark-mode focused interface built with Tailwind CSS v4.
  • 📱 Fully Responsive: Optimized for mobile, tablet, and desktop experiences.
  • 🔐 Secure Access: Role-based authentication for Admins and Users.
  • 📨 Advanced Mailbox Tools:
    • ⭐ Favorites: Pin important inboxes for quick access.
    • 🔄 Forwarding Rules: Set up auto-forwarding to real email addresses.
    • 👁️ Sanitized Viewing: Safe HTML email rendering with XSS protection.
    • 🔍 Filtering: Filter by All, Favorites, or Forwarding status.

🛠️ Tech Stack

React Vite Tailwind CSS Cloudflare Workers TypeScript D1 Database

🚀 Getting Started

Prerequisites

  • Node.js 18+
  • Cloudflare Account (for Workers & D1)
  • Wrangler CLI (npm install -g wrangler)

Installation

  1. Clone the repository

    git clone https://github.com/yourusername/open-temp-mail.git
cd open-temp-mail

  2. Install Dependencies

    npm install

  3. Run Development Server

    npm run dev

    Visit http://localhost:5173 to view the app.

🤝 Contributing

We love contributions! Please read our Contributing Guide to get started.

⚙️ Configuration

Open-Temp-Mail uses wrangler.toml for configuration.

Variable Description Example
MAIL_DOMAIN Your email domain(s), comma-separated "example.com, temp.io"
ADMIN_NAME Username for the admin dashboard "admin"

Secrets (Set via wrangler secret put):

  • ADMIN_PASSWORD: Secure password for admin access.
  • JWT_TOKEN: Random string for session security.
  • RESEND_API_KEY: (Optional) For sending emails via Resend.

    Note: Resend offers a free tier with 3000 emails/month, which is perfect for personal use.

📦 Deployment

One-Click Deployment

Run the automated setup script to create resources and deploy:

npm run deploy:setup

Manual Deployment

For detailed steps on manually configuring Cloudflare D1, R2, and Secrets, please refer to our Deployment Guide.

📂 Project Structure

open-temp-mail/
├── 📂 src/             # React Frontend Data & Components
├── 📂 worker/          # Cloudflare Worker Backend Logic
├── 📂 scripts/         # Setup & Utility Scripts
├── 📜 wrangler.toml    # Cloudflare Configuration
└── 📄 package.json     # Project Dependencies

Built with ❤️ by the Syntax-Error-1337