https://github.com/flolu/maizzle
Example for rendering beautiful emails with dynamic content using TailwindCSS
https://github.com/flolu/maizzle
emails maizzle nodejs posthtml tailwindcss typescript
Last synced: 6 months ago
JSON representation
Example for rendering beautiful emails with dynamic content using TailwindCSS
- Host: GitHub
- URL: https://github.com/flolu/maizzle
- Owner: flolu
- Created: 2022-12-23T19:28:18.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-24T11:27:03.000Z (about 3 years ago)
- Last Synced: 2025-04-05T00:24:10.922Z (9 months ago)
- Topics: emails, maizzle, nodejs, posthtml, tailwindcss, typescript
- Language: JavaScript
- Homepage:
- Size: 178 KB
- Stars: 25
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Rendering Emails with Maizzle
Example for rendering beautiful emails with dynamic content using TailwindCSS
# Features
- Build beautiful emails using TailwindCSS
- Add dynamic content to emails
- Render and send emails from Node.js
# Tech Stack
- [Maizzle](https://maizzle.com)
- [TailwindCSS](https://tailwindcss.com)
- [PostHTML](https://posthtml.org)
- [Node.js](https://nodejs.org)
- [TypeScript](https://www.typescriptlang.org)
# Usage
**Recommended OS**: Linux
**Requirements**: Node.js
**Setup**
- `npm install` (Install NPM dependencies)
- Set `MAILJET_PUBLIC_KEY` and `MAILJET_PRIVATE_KEY` in [`.env`](`.env`) ([Mailjet](https://www.mailjet.com))
**Commands**
- `npm run dev` (Start local development)
- `npx ts-node-dev server.ts` (Start mail rendering server, http://localhost:8080)
- Render and show email example: http://localhost:8080?name=Flo?&url=https://youtube.com/@flolu
- Render and send email example: http://localhost:8080/send/flo@drakery.com?name=Flo&url=https://youtube.com/@flolu
# Codebase
- [`src`](src) (Maizzle email templates)
- [`server.ts`](server.ts) (Node.js server to render and send the emails)