Skip to content

SaadMajeed565/MailingService

Repository files navigation

Mailing Service

Feature-complete mailing platform built with Laravel 12, Blade, and Tailwind CSS. Manage audiences, design templates, launch campaigns, and monitor engagement from a single dashboard.

Highlights

  • Audience Management — Contacts, mailing lists, categories, tags, manual segments, and rule-based segments.
  • Template Builder — Versioned HTML/Text templates with merge-variable documentation and design metadata.
  • Campaign Orchestration — Scheduling, batching, live recipient preparation, duplicate/snapshot workflows, and attachment support.
  • Analytics — Built-in dashboards for delivery, open/click metrics, geographic breakdowns, link engagement, and activity timelines.
  • Compliance & Preferences — Category opt-ins, per-recipient unsubscribe management, and manual status overrides.

Quick Start

  1. Install dependencies

    composer install
    npm install
    npm run build
  2. Environment

    cp .env.example .env
    php artisan key:generate

    The project is preconfigured for SQLite (database/database.sqlite).

  3. Database

    php artisan migrate --seed

    Seed data provisions: admin user (admin@example.com / password), sample contacts, tags, segments, categories, templates, campaigns, and analytics events.

  4. Serve

    php artisan serve

    Visit http://localhost:8000 to access the dashboard.

Product Guide

For a tour of features, workflows, and day-to-day usage, read the Mailing Service Product Guide.

Development Notes

  • Frontend assets are authored with Tailwind CSS and Vite. Run npm run dev for hot-reload development.
  • Mail delivery defaults to the log driver. Configure .env for SMTP or third-party providers as needed.
  • Campaign sending uses the CampaignDispatcher service. Extend it to integrate with queues or ESP APIs.
  • The project includes factories and comprehensive seeders to ease local testing or demos.

Testing

php artisan test

License

This project is open-sourced software licensed under the MIT license.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published