https://github.com/aduh95/newsletter-template-builder

https://github.com/aduh95/newsletter-template-builder

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/aduh95/newsletter-template-builder
• Owner: aduh95
• License: mit
• Created: 2019-08-05T21:00:02.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T00:53:42.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T22:41:29.506Z (5 months ago)
• Language: JavaScript
• Homepage: https://aduh95.github.io/newsletter-template-builder/
• Size: 3.42 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 21
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE

Awesome Lists containing this project

README

        
# Newsletter Template Builder

NTB aims to be a WYSIWYG editor to help you build a newsletter template. Using

this tool, you can design your newsletter and export its HTML without the need

to touch the code yourself.

### Goals of the project

This project aims to generate a lightweight web app, that should be installable

and offline-first. This project is designed to be as asynchronous as possible,

this is to ensure a good user experience.

Only last version of evergreen browsers are supported, support for older

browsers is a non-goal as it clashes with goal #1 (which is to keep the app as

lightweight as possible).

### Privacy

This app is serverless, meaning everything happens in your browser and nothing

is communicated to the outside world. In fact, you don't even need an internet

connection to use the app!

### Build your own NTB

This version of NTB comes with a limited set of widget for your newsletter. If

you feel to limited by the current set, you can fork this repo to add your own

widgets.

To build the app, with yarn, use the following:

```sh

yarn install

yarn build

```

You can run the development server with:

```sh

yarn start

```

You can create new widgets in `/src/components/` folder, don't forget to also

create their `/src/edit_components/` equivalent. You might want to customize

also `/src/App.js`.

PR are always welcome if you want your components to be available on the webapp.

All components are lazy-loaded, that means adding new widgets won't affect

clients performance if they are using them.