🌐 Nutifar Web SDK

Integrate reliable web push notifications into any modern JavaScript application with minimal setup.

Overview

The Nutifar Web SDK provides everything you need to integrate browser push notifications using Firebase Cloud Messaging (FCM) and the Nutifar platform.

Whether you're building with React, Next.js, Vue, Angular, Vite, or plain JavaScript, the SDK offers a consistent, TypeScript-first developer experience.

Features

• 🌐 Browser-first SDK
• 🔔 Firebase Cloud Messaging (FCM)
• ⚡ Lightweight and tree-shakeable
• 📦 TypeScript-first
• 🛠 Built-in CLI
• 🔒 Secure communication with Nutifar
• 🚀 Production-ready
• 🧩 Framework agnostic

Requirements

• Node.js 18+
• Modern browser with Service Worker support
• Firebase Cloud Messaging (FCM)

Installation

npm

npm install @nutifar/web

pnpm

pnpm add @nutifar/web

yarn

yarn add @nutifar/web

Initialize Your Project

After installing the SDK, initialize your project.

npx nutifar init

The CLI will automatically:

• Copy firebase-messaging-sw.js
• Create the public/ directory if needed
• Configure your project for background notifications

Quick Start

import { Nutifar } from "@nutifar/web";

const nutifar = new Nutifar({
  apiKey: "YOUR_PUBLIC_API_KEY",
});

await nutifar.initialize();

Service Worker

The CLI generates the following file inside your project:

public/
└── firebase-messaging-sw.js

Contents:

importScripts("https://api.nutifar.buzz/sw/v1/firebase-messaging-sw.js");

The hosted service worker is maintained by Nutifar and handles background notification delivery.

CLI

The SDK ships with a built-in CLI.

Initialize

npx nutifar init

Help

npx nutifar --help

Version

npx nutifar --version

Upcoming Commands

nutifar doctor
nutifar upgrade

Supported Frameworks

The SDK works with any modern JavaScript framework.

• React
• Next.js
• Vue
• Angular
• Svelte
• Vite
• Vanilla JavaScript

TypeScript

The SDK is written entirely in TypeScript and includes complete type definitions.

import { Nutifar } from "@nutifar/web";

No additional typings are required.

Examples

Example applications are available in the SDK repository.

• React + Vite
• Next.js
• Vanilla JavaScript

More examples will be added over time.

Browser Compatibility

Supported browsers must support:

• Service Workers
• Push API
• Notifications API
• Firebase Cloud Messaging

Roadmap

Available

• ✅ Web SDK
• ✅ Web CLI

Coming Soon

• Device Management
• Notification Analytics
• Rich Notifications
• Deep Linking
• Notification Inbox
• Message Templates
• Offline Queue

Contributing

Contributions are welcome!

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Open a Pull Request.

License

Released under the MIT License.

Made with ❤️ by BigYusuf.