Mailer

The easiest way to send organizing emails.

Introduction

Mailer is a full-stack application designed to be the easiest way for organizers to send and manage email campaigns. Built specifically for campaigns and non-profits, it features an intuitive email editor, advanced tracking, and is built with Next.js, React-Email, and supported by Vercel PostgreSQL and Prisma ORM.

Note

This project is in pre-alpha development. We may introduce breaking changes without warning. Please review PR details regularly for summaries of changes when pulling new versions of this repo.

Documentation

Getting Started

To get started with Mailer locally, follow these steps:

1. Install pnpm: If you haven't installed pnpm yet, run:

   npm install -g pnpm

2. Set up .env.local and update database URL

   cp .env.example .env.local
   sed "s/YOUR_DB_USER/$(whoami)/g" .env.local > .env.local.tmp && mv .env.local.tmp .env.local

3. Create database and run migrations

   createdb mailer
   pnpm prisma migrate deploy

4. Install dependencies and run the development server: In your project directory, run:

   pnpm i && pnpm dev

   Your localhost should now be live at http://app.localhost:3000

Create a production build

pnpm build

Database Commands

Publish Prisma Schema

npx prisma db push

Open Prisma studio

npx prisma studio

Built on open source

This project was built with open source technologies:

• Next.js as the React framework
• Tailwind for CSS styling
• Prisma as the ORM for database access
• Maily for email editing
• Vercel Postgres for the database
• Vercel Blob for image uploads
• NextAuth.js for authentication
• Tremor for charts
• Vercel for deployment

Contributing

• Create a pull request to add new a feature or fix a bug.
• Open an issue if you believe you've encountered a bug with the app.

License

AGPLv3

---