notifkit 0.1.6 → 0.1.8

package/README.md

@@ -85,7 +85,7 @@ flowchart TD
 
 In a single process, the API and all workers run in the same Node.js process (`services: ["all"]`), which works for small and medium apps, side projects, and staging. Distributed, you run stateless API servers (`services: ["api"]`) behind a load balancer and scale worker pools (`services: ["enricher", "engine", "delivery", "scheduler"]`) horizontally across Redis Streams consumer groups.
 
-## Quickstart
+## Quickstart (needs 5 mins)
 
 ### 1. Install
 
@@ -123,6 +123,8 @@ await server.start();
 console.log("notifkit listening on http://localhost:3000");
 ```
 
+`from` is required on `ResendTransport` — it is the sender for any template that does not name its own, and it has to be an address on a domain you have verified in Resend. A template can override it with its own `from`, so one transport can serve both `no-reply@` receipts and `marketing@` campaigns.
+
 `ADMIN_API_KEY` is the root credential. It is read from the environment, it is what mints project API keys in the next step, and without it the project-management routes answer `403`. Any string works locally:
 
 ```bash
@@ -173,8 +175,8 @@ await notifkit.syncTemplates({
   ],
 });
 
-// 2. Register a user
-await notifkit.addUser({ id: "usr_123", email: "alex@acme.com" });
+// 2. Register a user (supports id + contacts array or object)
+await notifkit.addUser("usr_123", [{ channel: "email", target: "alex@acme.com" }]);
 
 // 3. Dispatch
 await notifkit.notify({
@@ -263,20 +265,6 @@ notifkit is the durable notification layer that runs inside your own stack. It i
 
 First-party providers cover Resend, Firebase Cloud Messaging, Slack, Twilio, Telegram, Discord, and WhatsApp. Anything else is a `Transport` class with a `send()` method.
 
-### How this compares to Novu
-
-Novu is the established open-source project in this space, and if you want a notification platform with a dashboard, a visual workflow editor, and a drop-in in-app inbox component, use Novu. It is more mature, has a much larger community, and solves a broader problem.
-
-notifkit is a narrower, more embeddable take on the same layer:
-
-- **A library first, a platform second.** notifkit is an npm package you can run inside your existing Node process. Novu self-hosts as a set of services (API, worker, WebSocket server, dashboard SPA) that you deploy and operate alongside your app.
-- **Postgres, not MongoDB.** notifkit stores state in PostgreSQL with Drizzle migrations and queues in Redis Streams. If Postgres is already your database, there is no new datastore to run.
-- **Workflows as code.** Multi-step sequences are typed TypeScript, versioned in your repo, rather than built in a visual editor.
-- **MIT, all of it.** There is no open-core split. Novu is MIT at the core with enterprise features under a commercial license; notifkit has no feature held back from the self-hosted build.
-- **MCP as a first-class interface.** Agents operate the same infrastructure your app uses, including triage and delivery-log inspection.
-
-What notifkit does not have: an in-app notification center or inbox component, a web dashboard for non-engineers, digest aggregation, or Novu's provider catalog. If you need those, Novu is the better fit.
-
 ## Agent-operable
 
 https://github.com/user-attachments/assets/4dff98bb-37d3-44b4-bf46-9607c1cd89b5

package/dashboard/README.md

@@ -0,0 +1,29 @@
+# Notifkit Admin & Observability Dashboard
+
+This is the single-page application (SPA) admin console and real-time delivery observability dashboard for **Notifkit**, built with **Vite**, **React 19**, **React Router**, **Tailwind CSS v4**, and **shadcn/ui**.
+
+## Development
+
+```bash
+# Start Vite development server
+npm run dev
+
+# Build production bundle to dist/
+npm run build
+
+# Preview built production bundle
+npm run preview
+```
+
+## Features
+
+- **Live Activity Feed**: Real-time SSE streaming of delivery statuses and handoffs.
+- **Historical Audit Logs**: Queryable, paginated notification lifecycle trails and payload inspector.
+- **System Health**: PostgreSQL and Redis latencies and worker heartbeat monitoring.
+- **Analytics & Queues**: Real-time Redis Streams queue depth gauges and delivery SLA metrics.
+- **Dead Letter Queue (DLQ)**: Poison message diagnostics with stream replay and purge capabilities.
+- **Scheduled Pipeline**: Future dispatch scheduling and quiet hours deferrals.
+- **Workflows**: Multi-step notification sequence diagrams and instance step execution tracing.
+- **Templates**: Channel bindings, dynamic variables, and prompt previewing.
+- **User Directory**: Contact channels and opt-out preferences.
+- **Projects & API Keys**: Tenant workspace configuration and scoped token provisioning.