Vynemit 🔔

Vynemit is a powerful, flexible, and framework-agnostic notification system designed to unify all your communication channels (In-App, Push, Email, SMS, and Webhooks) into a single, cohesive workflow.

🚀 The Ecosystem

The Vynemit ecosystem consists of several packages designed to work together or independently:

• Vynemit Core (@vynelix/vynemit-core): The heart of the system. Framework-agnostic logic for dispatching, templates, and middleware.
• Vynemit NestJS (@vynelix/vynemit-nestjs): A seamless wrapper for NestJS applications with built-in WebSocket gateways and REST APIs.
• Vynemit Adapters: Collection of transport and storage adapters (SMTP, SendGrid, FCM, Twilio, Postgres).
• Vynemit React (@vynelix/vynemit-react): Frontend hooks and providers for React/Next.js to receive real-time notifications.

✨ Key Features

• Unified API - Send notifications to any channel using a single interface.
• 🎨 Dynamic Templating - Handle complex notification layouts with ease.
• ⚡ Real-time Delivery - Built-in support for WebSockets and SSE.
• 🗄️ Pluggable Storage - Persistent notification history with your choice of database.
• 🔌 Extensible Adapters - Easily swap or add new transport providers.
• 🔄 Middleware Pipeline - Hook into the notification lifecycle for custom logic.

Quick Start (NestJS)

npm install @vynelix/vynemit-nestjs @vynelix/vynemit-core

import { NotificationsModule } from '@vynelix/vynemit-nestjs';
import { ConsoleTransportAdapter, MemoryStorageAdapter } from '@vynelix/vynemit-core';

@Module({
  imports: [
    NotificationsModule.forRoot({
      storage: new MemoryStorageAdapter(),
      transports: [new ConsoleTransportAdapter('email')]
    })
  ]
})
export class AppModule {}

📖 Deep Dives

• How it Works
• Integrating with NestJS
• Available Adapters
• Frontend Real-time Updates

🤝 Contributing

We welcome contributions! Please check out our Contributing Guide.

📄 License

MIT © Engr., Isaiah Pius E.