CalvinBackup/MailComposer
1
0
Fork 0
mirror of https://github.com/Gowtham-Darkseid/MailComposer.git synced 2026-09-18 17:42:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update README with GitHub badges and quick start guide

Browse Source
This commit is contained in:
gowtham-darkseid
2025-09-09 21:19:25 +05:30
parent 44ea4d2e64
commit f4d8f0c526
1 changed files with 30 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+30 -31
View File
@@ -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. 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 ## Features
### ✉️ Core Email Functionality ### ✉️ 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 - **Unsaved changes warning** - Alerts before leaving page with unsaved content
- **Error handling** - Graceful handling of failures - **Error handling** - Graceful handling of failures
## Getting Started ## 🎯 Quick Start
### Prerequisites ```bash
- Node.js (v14 or higher) # Clone the repository
- npm or yarn git clone https://github.com/Gowtham-Darkseid/MailComposer.git
- Firebase account (for email sending)
### Quick Start # Navigate to project directory
cd MailComposer
1. Clone or download this project # Install dependencies
npm install
2. Install dependencies: # Start development server
```bash npm run dev
npm install ```
```
3. Set up Firebase (for email sending): ### 📧 Enable Real Email Sending
```bash
# Follow the detailed guide in FIREBASE_SETUP.md
cp .env.example .env
# Edit .env with your Firebase configuration
```
4. Start the development server: 1. **Create free [EmailJS account](https://www.emailjs.com/)**
```bash 2. **Set up email service** (Gmail recommended)
npm run dev 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`) *See [EmailJS Setup Guide](./EMAILJS_SETUP.md) for detailed instructions.*
### 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.
### Building for Production ### Building for Production