An open API service indexing awesome lists of open source software.

https://github.com/webscopeio/mailingui

MailingUI is an open source collection of email components and templates
https://github.com/webscopeio/mailingui

email email-template react

Last synced: 3 months ago
JSON representation

MailingUI is an open source collection of email components and templates

Awesome Lists containing this project

README

          

# Mailing UI

## Description

MailingUI is a set of _opinionated_ React components, built on top of [React.email](https://react.email), designed to make the creation of emails easier.

> "We believe that email is an extremely important medium for people to communicate. However, we need to stop developing emails like 2010, and rethink how email can be done in 2022 and beyond. Email development needs a revamp. A renovation. Modernized for the way we build web apps today"
—[React.email](https://react.email).

All of our components are completely **open-sourced** and intended for a
*copy-and-paste* use. Currently, we don't have any plans in releasing MailingUI as an npm
package.

## Documentation

- To get started, please visit [Docs - Guide](https://mailingui.com/docs/guide/introduction)
- View our components at [Docs - Components](https://mailingui.com/docs/components/overview)
- View our templates at [Templates](https://mailingui.com/templates/minimal/overview)

## Contributing

- [Contribution Guide](contributing.md)

## Dependencies

- **Node.js** - recommended and tested version is the current latest version - `v20.5.0`. (The table of releases: https://nodejs.org/en/download/releases)
- **pnpm** - space efficient and faster adaptation of `npm`. The recommended version is current latest version - `8.6.11`. Can be installed with npm via `npm install -g pnpm` or with corepack via `corepack prepare pnpm@8.6.11 --activate`.

## Installation

First, install the dependencies:

```bash
pnpm i
```

Then run the development server:

```bash
pnpm dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

## Open source licensing info

- [LICENSE](LICENSE)