GitHub

Mail Assist Documentation

A modern, professional email-sending platform built with cutting-edge technologies for developers who need reliable email delivery with an intuitive interface.

Welcome
This documentation will guide you through setting up, configuring, and using Mail Assist to send emails efficiently with built-in credit management and template systems.

What is Mail Assist?

Mail Assist is a comprehensive email-sending platform that combines the power of modern web technologies to provide a seamless email delivery experience. Built with Next.js 14, TypeScript, and integrated with Supabase for authentication and data management, plus Resend for reliable email delivery.

Key Features

  • Custom Email Sending - Send personalized emails with custom content (5 credits)
  • Template-Based Emails - Use pre-built templates for common scenarios (10 credits)
  • Credit Management - Built-in credit system with 300 default credits
  • Email History - Track and view all sent emails in your dashboard
  • Live Preview - Preview emails before sending
  • Secure Authentication - Powered by Supabase Auth
  • Responsive Design - Works perfectly on all devices

Technology Stack

Frontend

  • •Next.js 14 (App Router)
  • •TypeScript
  • •Tailwind CSS
  • •ShadCN/UI Components

Backend & Services

  • •Supabase (Auth & Database)
  • •Resend (Email Delivery)
  • •Server Actions
  • •API Routes

Use Cases

Mail Assist is perfect for:

  • Developers - Integrate email functionality into applications
  • Small Businesses - Send marketing and transactional emails
  • Content Creators - Manage newsletter campaigns
  • Agencies - Handle client email communications
Ready to Setup Mail Assist Locally?
Head over to the Developer Quickstart guide to set up Mail Assist in your local environment.

Quick Start

Get up and running in minutes:

# Clone the repository
git clone https://github.com/Abusha-Ansari/Mail-Assist

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env.local

# Run the development server
npm run dev

Visit http://localhost:3000 to see Mail Assist in action!