mirror of
https://github.com/xodivorce/mailer-dev-console.git
synced 2025-12-19 07:42:57 +05:30
(chore): initial MVP release
This commit is contained in:
59
README.md
Normal file
59
README.md
Normal file
@@ -0,0 +1,59 @@
|
||||
## SteamsTube: 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.
|
||||
|
||||
[](https://github.com/xodivorce/steamstube-in/)
|
||||
[](https://github.com/xodivorce/steamstube-in/)
|
||||
[](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
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
### 🛠️ 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?**
|
||||
Don’t 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**.
|
||||
Reference in New Issue
Block a user