https://github.com/watzon/postpilot
Local SMTP testing made easy
https://github.com/watzon/postpilot
developer-tools email email-testing smtp smtp-server
Last synced: 9 months ago
JSON representation
Local SMTP testing made easy
- Host: GitHub
- URL: https://github.com/watzon/postpilot
- Owner: watzon
- License: mit
- Created: 2024-11-10T01:54:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-03T21:18:52.000Z (over 1 year ago)
- Last Synced: 2025-01-03T22:25:00.237Z (over 1 year ago)
- Topics: developer-tools, email, email-testing, smtp, smtp-server
- Language: TypeScript
- Homepage: http://postpilot.watzon.tech/
- Size: 1.5 MB
- Stars: 32
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
PostPilot
A sleek local SMTP testing environment for developers
[](https://goreportcard.com/report/github.com/watzon/postpilot)
[](https://repology.org/project/postpilot/versions)
## ⚠️ Alpha Status
PostPilot is currently in alpha. While the core functionality is working, you may encounter bugs or missing features. Use in development environments only.
## About
PostPilot is a developer tool inspired by Laravel Herd's mail panel, designed to simplify email testing during development. It provides a local SMTP server that captures outgoing emails and displays them in a modern, user-friendly interface.
## Features
### Current
- 📬 Local SMTP server for email testing
- 🎨 Modern, responsive UI built with React and Tailwind CSS
- 🌓 Light/Dark mode support
- 📱 Preview emails in different formats (HTML, Text, Raw)
- 🔍 Basic search capabilities
### Installation
If you're on Linux or Windows you can go check out the [releases page](https://github.com/watzon/postpilot/releases) and download the binary for your platform. As I don't yet have a Windows signing certificate, Windows users will have to skip past the scary "This software may harm your computer" warning, or build from source using the below instructions.
Arch users can install PostPilot from the AUR:
```bash
yay -S postpilot-bin
```
Distro packaging is sparse right now, but you can help with that!
[](https://repology.org/project/postpilot/versions)
## Building from source
1. Clone the repository
```bash
git clone https://github.com/watzon/postpilot.git
```
2. Build and install
```bash
make build
sudo make install
```
The binary will be installed to `/usr/local/bin/postpilot` and the desktop file will be installed to `/usr/share/applications/postpilot.desktop`.
## Development
Development requires the Wails CLI, which you can install with:
```bash
go install github.com/wailsapp/wails/v3/cmd/wails@latest
```
Run `wails doctor` to check your development environment. You will need to have the following installed:
- Go
- Node.js
- npm
- GTK 3.0
- WebKitGTK 4.0
Then run the following command to start the development server:
```bash
wails dev
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
## License
This project is licensed under the MIT License.
## Acknowledgments
- Inspired by Laravel Herd's mail panel
- Built with [Wails](https://wails.io/)
- Uses [React](https://reactjs.org/) and [Tailwind CSS](https://tailwindcss.com/)