From f4d8f0c526da545f4791b602dcde6e7f38eb3f7a Mon Sep 17 00:00:00 2001 From: gowtham-darkseid Date: Tue, 9 Sep 2025 21:19:25 +0530 Subject: [PATCH] docs: Update README with GitHub badges and quick start guide --- README.md | 61 +++++++++++++++++++++++++++---------------------------- 1 file changed, 30 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 4de8fd3..6cdd9dd 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,18 @@ -# Mail Composer +# 📧 Mail Composer + +[![GitHub stars](https://img.shields.io/github/stars/Gowtham-Darkseid/MailComposer?style=social)](https://github.com/Gowtham-Darkseid/MailComposer/stargazers) +[![GitHub forks](https://img.shields.io/github/forks/Gowtham-Darkseid/MailComposer?style=social)](https://github.com/Gowtham-Darkseid/MailComposer/network) +[![GitHub issues](https://img.shields.io/github/issues/Gowtham-Darkseid/MailComposer)](https://github.com/Gowtham-Darkseid/MailComposer/issues) +[![GitHub license](https://img.shields.io/github/license/Gowtham-Darkseid/MailComposer)](https://github.com/Gowtham-Darkseid/MailComposer/blob/main/LICENSE) A modern, feature-rich email composer application built with vanilla JavaScript, HTML, CSS, and Firebase for real email sending capabilities. +![Mail Composer Demo](https://via.placeholder.com/800x400/3b82f6/white?text=Mail+Composer+Demo) + +## 🚀 Live Demo + +[Try Mail Composer Live](https://your-deployment-url.com) *(Coming Soon)* + ## Features ### ✉️ Core Email Functionality @@ -46,43 +57,31 @@ A modern, feature-rich email composer application built with vanilla JavaScript, - **Unsaved changes warning** - Alerts before leaving page with unsaved content - **Error handling** - Graceful handling of failures -## Getting Started +## 🎯 Quick Start -### Prerequisites -- Node.js (v14 or higher) -- npm or yarn -- Firebase account (for email sending) +```bash +# Clone the repository +git clone https://github.com/Gowtham-Darkseid/MailComposer.git -### Quick Start +# Navigate to project directory +cd MailComposer -1. Clone or download this project +# Install dependencies +npm install -2. Install dependencies: - ```bash - npm install - ``` +# Start development server +npm run dev +``` -3. Set up Firebase (for email sending): - ```bash - # Follow the detailed guide in FIREBASE_SETUP.md - cp .env.example .env - # Edit .env with your Firebase configuration - ``` +### 📧 Enable Real Email Sending -4. Start the development server: - ```bash - npm run dev - ``` +1. **Create free [EmailJS account](https://www.emailjs.com/)** +2. **Set up email service** (Gmail recommended) +3. **Create email template** with variables: `{{to_email}}`, `{{subject}}`, `{{message}}` +4. **Update `emailjs-config.js`** with your credentials +5. **Start sending real emails!** -5. Open your browser and navigate to the URL shown in the terminal (typically `http://localhost:5173`) - -### Firebase Setup - -For full email sending functionality, you need to set up Firebase. See the detailed [Firebase Setup Guide](./FIREBASE_SETUP.md) for step-by-step instructions. - -### Development Mode - -Without Firebase setup, the application will work in development mode with simulated email sending for testing the UI and functionality. +*See [EmailJS Setup Guide](./EMAILJS_SETUP.md) for detailed instructions.* ### Building for Production