Files
mailer-dev-console/README.md
2025-11-16 19:08:31 +05:30

59 lines
2.7 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
## Mailer Dev Console: powered by @xodivorce
### 👀 Preview
<img src="./images/mailer-dev-console-preview.png" alt="mailer-dev-console-preview">
#### A live email preview and sending console that lets developers instantly render, test, and deliver HTML templates with real-time updates and SMTP integration.
[![status](https://img.shields.io/badge/status-active-brightgreen.svg?style=flat)](https://github.com/xodivorce/steamstube-in/)
[![version](https://img.shields.io/badge/version-v1.0.0-yellow.svg?style=flat)](https://github.com/xodivorce/steamstube-in/)
[![PRs](https://img.shields.io/badge/PRs-welcome-blue.svg?style=flat)](https://github.com/xodivorce/steamstube-in/)
> **🥰 Like this project? Please consider giving it a Star (🌟) on GitHub to show us your appreciation. Thank you!**
### ⚡️ Technologies Used
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
![PHP](https://img.shields.io/badge/php-%23777BB4.svg?style=for-the-badge&logo=php&logoColor=white)
### 🛠️ Installation
Want to get started quickly? Follow the instructions below to install and run the project on your system.
1. **Clone the repository**
- Clone the repository to your local machine:
```bash
# Clone using SSH
git clone git@github.com:xodivorce/mailer-dev-console.git
# Or using HTTPS
git clone https://github.com/xodivorce/mailer-dev-console.git
```
2. **Set up your environment**
- Install [PHP](https://www.google.com/search?client=safari&rls=en&q=php&ie=UTF-8&oe=UTF-8), [Apache](https://www.apache.org) or [XAMPP](https://www.apachefriends.org).
3. **Install dependencies**
- Navigate to the project directory `htdocs`:
```bash
# Go to the directory
cd htdocs
```
4. **Configure Environment & Database**
- Set up your `.env` file based on `.env.example` file.
🐞 **Got Ideas or Spotted a Bug?**
Dont be shy! [*Open an issue*](https://github.com/xodivorce/mailer-dev-console/issues) to discuss new features, enhancements, or any bugs you find. Your feedback is golden!!
### 📄 License
This project is licensed under the [MIT License](LICENSE.txt). You are free to use, modify, and distribute this project, provided that proper credit is given to the original authors.
> 🧠 Follow me on [Instagram](https://www.instagram.com/xodivorce) or check out more projects at [xodivorce.in](https://www.xodivorce.in)
<br></br>
****
An Open-source project - crafted with ❤️ by **xodivorce**.