npm package: @followup/core
Description: Notification Management Framework
Latest version: 0.3.7

# ⭐️ Followup Core

Building a notification system is hard, at first it seems like just sending an email but in reality it's just the beginning. In today's world users expect multi channel communication experience over email, sms, push, direct and more... An ever growing list of providers are popping up each day, and notifications are spread around the code. Followup's goal is to simplify notifications and provide developers the tools to create meaningful communication between the system and it's users.

## ✨ Features

- 🌈 Single API for all messaging providers (Email, SMS, Push, Direct)
- 💅 Easily manage notification over multiple channels
- 🚀 Equipped with a templating engine for advanced layouts and designs 
- 🛡 Built-in protection for missing variables
- 📦 Easy to set up and integrate
- 🛡 Written in TypeScript with predictable static types.
- 👨‍💻 Community driven

## 📦 Install

```bash
npm install @followup/core
```

```bash
yarn add @followup/core
```

## 🔨 Usage

```ts
import { Followup, ChannelTypeEnum } from '@followup/core';
import { SendgridEmailProvider } from '@followup/sendgrid';

const followup = new Followup();

await followup.registerProvider(
  new SendgridEmailProvider({
    apiKey: process.env.SENDGRID_API_KEY,
    from: 'sender@mail.com'
  })
);

const passwordResetTemplate = await followup.registerTemplate({
  id: 'password-reset',
  messages: [
    {
      subject: 'Your password reset request',
      channel: ChannelTypeEnum.EMAIL,
      template: `
          Hi {{firstName}}!
          
          To reset your password click <a href="{{resetLink}}">here.</a>
          
          {{#if organization}}
            <img src="{{organization.logo}}" />
          {{/if}}
      `
    },
  ]
});

await followup.trigger('<REPLACE_WITH_EVENT_NAME>', {
  $user_id: "<USER IDENTIFIER>",
  $email: "test@email.com",
  firstName: "John",
  lastName: "Doe",
  organization: {
    logo: 'https://evilcorp.com/logo.png'
  }
});
```

## Providers
Followup provides a single API to manage providers across multiple channels with a single to use interface.

#### 💌 Email
- [x] [Sendgrid](https://github.com/followuphq/followup/tree/master/providers/sendgrid)
- [x] [Mailgun](https://github.com/followuphq/followup/tree/master/providers/mailgun)
- [x] [SES](https://github.com/followuphq/followup/tree/master/providers/ses)
- [x] [Postmark](https://github.com/followuphq/followup/tree/master/providers/postmark)
- [x] [NodeMailer](https://github.com/followuphq/followup/tree/master/providers/nodemailer)
- [x] [Mailjet](https://github.com/followuphq/followup/tree/master/providers/mailjet)
- [x] [Mandrill](https://github.com/followuphq/followup/tree/master/providers/mandrill)
- [ ] SendinBlue
- [ ] SparkPost

#### 📞 SMS
- [x] [Twilio](https://github.com/followuphq/followup/tree/master/providers/twilio)
- [x] [Plivo](https://github.com/followuphq/followup/tree/master/providers/plivo)
- [x] [SNS](https://github.com/followuphq/followup/tree/master/providers/sns)
- [x] Nexmo (Vonage)(https://github.com/followuphq/followup/tree/master/providers/nexmo)
- [ ] Bandwidth
- [ ] RingCentral

#### 📱 Push (Coming Soon...)
- [ ] Pushwoosh
- [ ] SNS

#### 👇 Direct (Coming Soon...)
- [ ] Slack
- [ ] MS Teams
- [ ] Discord
- [ ] Mattermost

#### 📱 In-App (Coming Soon...)
- [ ] Followup
- [ ] MagicBell

#### Other (Coming Soon...)
- [ ] PagerDuty

## 🔗 Links
- [Home page](https://followup.so/)