Open-Temp-Mail

Author: Syntax-Error-1337

README.md

@@ -1,54 +1,88 @@
-# Freemail Version 2
+# 📬 Open-Temp-Mail
 
-A modern, responsive frontend for the Freemail application, built with React, Vite, and Tailwind CSS.
+[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/deploy-button.svg)](https://deploy.workers.cloudflare.com/?url=https://github.com/yourusername/open-temp-mail)
+![License](https://img.shields.io/badge/license-MIT-blue.svg)
+![Version](https://img.shields.io/badge/version-1.0.0-green.svg)
+![Status](https://img.shields.io/badge/status-stable-success.svg)
 
-## Features
-- **Modern UI**: Clean interface built with Tailwind CSS v4.
-- **Authentication**: Secure login for Admins, Users, and Mailbox accounts.
-- **Dashboard**: Overview of system status and mailboxes.
-- **Mailbox Management**: 
-    - **Favorites**: Star important mailboxes for quick access.
-    - **Filtering**: Easily filter by All, Favorites, or Forwarding status.
-    - **Forwarding**: Set up auto-forwarding rules for mailboxes.
-- **Mailbox**: Real-time email listing and reading with sanitized HTML view.
-- **Responsive**: Fully optimized for mobile and desktop.
+**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.
 
-## Getting Started
+---
+
+## ✨ 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](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
+![Vite](https://img.shields.io/badge/Vite-646CFF?style=for-the-badge&logo=vite&logoColor=white)
+![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)
+![Cloudflare Workers](https://img.shields.io/badge/Cloudflare_Workers-F38020?style=for-the-badge&logo=cloudflare&logoColor=white)
+![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
+![D1 Database](https://img.shields.io/badge/Cloudflare_D1-F38020?style=for-the-badge&logo=cloudflare&logoColor=white)
+
+## 🚀 Getting Started
 
 ### Prerequisites
-- Node.js 18+
-- Backend Cloudflare Worker running locally (default port 8787).
+- **Node.js** 18+
+- **Cloudflare Account** (for Workers & D1)
 
 ### Installation
-1. Install dependencies:
-   ```bash
-   npm install
-   ```
 
-2. Start the development server:
-   ```bash
-   npm run dev
-   ```
+1.  **Clone the repository**
+    ```bash
+    git clone https://github.com/yourusername/open-temp-mail.git
+    cd open-temp-mail
+    ```
 
-3. Open `http://localhost:5173` in your browser.
+2.  **Install Dependencies**
+    ```bash
+    npm install
+    ```
 
-## Configuration
-The frontend is configured to proxy API requests to `http://localhost:8787`.
-To change this, edit `vite.config.ts`.
+3.  **Run Development Server**
+    ```bash
+    npm run dev
+    ```
+    Visit `http://localhost:5173` to view the app.
 
-## Deployment
-See [DEPLOY.md](DEPLOY.md) for detailed instructions.
+## 📦 Deployment
+
+Open-Temp-Mail is designed to be deployed effortlessly to Cloudflare.
 
 ### One-Click Deployment
-For a quick setup, run:
+For a quick setup, run the automated setup script:
 ```bash
 npm run deploy:setup
 ```
-This script will automate resource creation, configuration, and deployment.
+This script will automate resource creation (D1 User DB), configuration, and initial deployment.
 
 ### Manual Deployment
-To build for production manually:
+For granular control over the deployment process, please refer to the detailed **[DEPLOY.md](./DEPLOY.md)** guide.
+
+## 📂 Project Structure
+
 ```bash
-npm run build
+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
 ```
-The output will be in the `dist` directory, which is served by the Cloudflare Worker.
+
+---
+
+<p align="center">
+  Built with ❤️ by the Open Source Community
+</p>

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "version-2",
+  "name": "open-temp-mail",
   "private": true,
   "version": "0.0.0",
   "type": "module",

wrangler.toml

@@ -1,4 +1,4 @@
-name = "freemail-v2"
+name = "open-temp-mail"
 main = "worker/src/server.js"
 compatibility_date = "2024-01-01"