Code Monkey home page Code Monkey logo

stormkit-io / mailer Goto Github PK

View Code? Open in Web Editor NEW
26.0 3.0 6.0 630 KB

Deploy your own free, open-source email service with a single click. Connect seamlessly with Gmail or Amazon SES for secure and customizable email management. Take control of your communication with ease.

Home Page: https://mailer-demo.stormkit.dev

License: MIT License

HTML 0.22% TypeScript 99.43% Dockerfile 0.20% JavaScript 0.15%
email email-sender marketing-automation open-source self-hosted transactional-emails

mailer's Introduction

Stormkit Mailer (under active development)

Send automated emails, or launch campaigns through a simple API or an intuitive UI.

Live Demo

Visit https://mailer-demo.stormkit.dev.

  • Username: root
  • Password: 123456

It's a limited, read-only version.

Features

☑️  SES Mailer: Send emails through your own Amazon SES account.

✅  SMTP: Send emails through SMTP, such as your own Gmail account.

☑️  Gmail API Send emails through Gmail API.

✅  Minimal UI: Simple, intuitive UI to configure your templates

☑️  Subscribers: Upload your subscribers either through API or manually

☑️  Unsubscribe: Users can unsubscribe

☑️  API: Send emails to your users through a simple API

✅  Free Forever: Using Stormkit Mailer is free of charge

Legend

✅ Ready to use

☑️ Incomplete or not yet started

Configuration

The Mailer is configured through environment variables. You can configure these variables either by providing an .env file or by making these variables available to your process.

Variable Description
ADMIN_USERNAME The user name that is used to login the Mailer app.
ADMIN_PASSWORD The password that is used to login the Mailer app.
SMTP_USERNAME The user name that is used to login your SMTP provider.
SMTP_PASSWORD The password that is used to login your SMTP provider.
JWT_SECRET A random string that is used to encrypt your JWT tokens.
MAILER_FROM_ADDR The address that will be used to send emails.

Note that some of these variables will be moved to the configuration page once the page is implemented. See #2 for more details.

Local development

See Docker for containarized environments.

$ git clone [email protected]:stormkit-io/mailer.git
$ cd mailer
$ npm install
$ npm run dev

Create an .env file on the root level of the repository and configure the environment variables mentioned in the Configuration section.

✅ HMR enabled

✅ To force restarting the server, type rs and hit Enter on the terminal

Docker

$ docker build -t mailer .
$ docker run -t mailer

Currently, the container does not stop when a Stop Signal is sent. See #12 for more context.

To stop the container, you can execute:

$ docker stop $(docker ps -q --filter ancestor=mailer)

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.