https://github.com/cityssm/node-ntfy-publish

A Node package to publish notifications to an ntfy server.
https://github.com/cityssm/node-ntfy-publish

alerts messages notifications ntfy push-notifications

Last synced: 3 months ago
JSON representation

A Node package to publish notifications to an ntfy server.

• Host: GitHub
• URL: https://github.com/cityssm/node-ntfy-publish
• Owner: cityssm
• License: mit
• Created: 2022-11-09T14:27:09.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-04T14:32:49.000Z (about 1 year ago)
• Last Synced: 2024-12-03T01:45:53.048Z (11 months ago)
• Topics: alerts, messages, notifications, ntfy, push-notifications
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@cityssm/ntfy-publish
• Size: 392 KB
• Stars: 14
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# node-ntfy-publish

[![npm (scoped)](https://img.shields.io/npm/v/@cityssm/ntfy-publish)](https://www.npmjs.com/package/@cityssm/ntfy-publish)

[![codecov](https://codecov.io/gh/cityssm/node-ntfy-publish/branch/main/graph/badge.svg?token=2WG6ZIYQXS)](https://codecov.io/gh/cityssm/node-ntfy-publish)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cityssm/node-ntfy-publish/coverage.yml?branch=main)](https://github.com/cityssm/node-ntfy-publish/actions/workflows/coverage.yml)

[![DeepSource](https://app.deepsource.com/gh/cityssm/node-ntfy-publish.svg/?label=active+issues&show_trend=true&token=gRsFQOduwYOCD7qQFXn6B1gO)](https://app.deepsource.com/gh/cityssm/node-ntfy-publish/)

A Node package to publish push notifications to a phone or desktop

through an [ntfy](https://ntfy.sh/) server.

## Getting Started

```bash

npm install @cityssm/ntfy-publish

```

```javascript

import ntfyPublish from '@cityssm/ntfy-publish'

await ntfyPublish({

  topic: 'cityssm-test',

  priority: 'high',

  title: 'Test High Priority Message',

  message: '1, 2, 3',

  tags: ['warning', 'computer'],

  iconURL: 'https://avatars.githubusercontent.com/cityssm',

  clickURL: 'https://github.com/cityssm/node-ntfy-publish'

})

```

For information on how to subscribe to notifications on your phone or desktop,

[visit the ntfy website](https://ntfy.sh/).

## Related Projects on NPM

- [ntfy](https://www.npmjs.com/package/ntfy) - Send notifications over ntfy.sh