Skip to content

Latest commit

 

History

History
91 lines (60 loc) · 2.82 KB

README.md

File metadata and controls

91 lines (60 loc) · 2.82 KB
PostPilot Logo

PostPilot

A sleek local SMTP testing environment for developers

Go Report Card Packaging status

⚠️ 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.

PostPilot Screenshot

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 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:

yay -S postpilot-bin

Distro packaging is sparse right now, but you can help with that!

Packaging status

Building from source

  1. Clone the repository

    git clone https://github.com/watzon/postpilot.git
  2. Install dependencies

    make dep
  3. Build the project

    make build

The binary will be located in the build/bin directory.

Development

Development requires the Wails CLI, which you can install with:

go install github.com/wailsapp/wails/v3/cmd/wails@latest

Then run the following command to start the development server:

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