Repository navigation
馃摝 npm package: https://www.npmjs.com/package/notifkit/v/0.1.13
What's New in v0.1.13
npm create notifkit: Scaffold a working app in one command withnpm create notifkit@latest my-app. It writes aserver.ts, asetup.tsthat creates a project and
savesNOTIFKIT_API_KEYto.env, and asend.tsthat syncs a template, adds a user and
sends to them. The.envgets a randomly generatedADMIN_API_KEY. Then runnpm run dev,
and in a second terminalnpm run setupandnpm run send.- Providers: The default
consoleprovider prints notifications to the server terminal,
so you can try notifkit without a provider account. Pass--provider resend,twilioor
fcmto start with a real one..envlists the credentials each provider needs. - Options:
--no-installskips installing dependencies,--forcewrites into a
non-empty directory, and.scaffolds into the current directory. With no arguments in a
terminal, it asks for the name and provider. pnpm, yarn and bun are detected automatically
(pnpm create notifkit my-app). notifkit create: Thenotifkitpackage now has anotifkitcommand, andnpx notifkit create my-appruns the same scaffolder.- README & Docs: The README is reorganised around a single quickstart, with a comparison
against Novu, Knock and Courier and a "what it handles" table. Step-by-step setup moved to
the full quickstart.
Packages
create-notifkit: https://www.npmjs.com/package/create-notifkit/v/0.1.0
Install
npm create notifkit@latest my-app
# or, in an existing app
npm install notifkit@0.1.13