onesignal-node-sample

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

onesignal-node-sample

★ 10 Open GitHub ↗

This is a sample app to demonstrate the usage of the NodeJS client library from OneSignal to send and view notifications.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
  <a href="https://documentation.onesignal.com/docs/onboarding-with-onesignal" target="_blank">Quickstart</a>
  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
  <a href="https://onesignal.com/" target="_blank">Website</a>
  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
  <a href="https://documentation.onesignal.com/docs" target="_blank">Docs</a>
  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
  <a href="https://github.com/OneSignalDevelopers" target="_blank">Examples</a>
  <br />
 <br />
</div>

![OneSignal](https://github.com/OneSignalDevelopers/.github/blob/main/assets/onesignal-banner.png?raw=true)

# OneSignal Node Sample

OneSignal makes engaging customers simple and is the fastest, most reliable service to send push notifications, in-app messages, SMS, and emails.

This project demonstrates integrating the **OneSignal Node SDK**. You can use this project as a boilerplate or reference to start your project.

## 🚦 Getting started

This project assumes that you already have a OneSignal app created with push notifications setup. If you don't yet have a OneSignal app, [create one](https://documentation.onesignal.com/docs/apps-organizations#create-an-app) first.

### Requirements

* Node v18
* OneSignal account and project.

### Usage

From your terminal:

1. Clone this project
2. `cd` into the repository
3. Install dependencies by running `yarn`
4. Open the `.env.local` environment file
5. Set `ONESIGNAL_AUTH_KEY` and `ONESIGNAL_REST_API_KEY` environment variables
6. Run a command e.g., `./bin/dev app list`

For additional command help, run `.bin/dev --help`

```bash
╰─$ ./bin/dev --help
Sample project demonstrating how to use OneSignal's Node backend SDK

VERSION
  onesignal-node-sample/0.0.0 darwin-arm64 node-v18.16.0

USAGE
  $ onesignal-node-sample [COMMAND]

TOPICS
  app           Create a new OneSignal app.
  notification  Send a message to a user or segment.
  plugins       List installed plugins.
  user          Create a new user.

COMMANDS
  help     Display help for onesignal-node-sample.
  plugins  List installed plugins.
```

## Support

Consider giving this repo a star ⭐️ if this project helped you.

### ❤️ Developer Community

For additional resources, please join the [OneSignal Developer Community](https://onesignal.com/onesignal-developers).

Get in touch with us or learn more about OneSignal through the channels below.

* [Follow us on Twitter](https://twitter.com/onesignaldevs) to never miss any updates from the OneSignal team, ecosystem & community
* [Join us on Discord](https://discord.gg/EP7gf6Uz7G) to be a part of the OneSignal Developers community, showcase your work and connect with other OneSignal developers
* [Read the OneSignal Blog](https://onesignal.com/blog/) for the latest announcements, tutorials, in-depth articles & more.
* [Subscribe to us on YouTube](https://www.youtube.com/channel/UCe63d5EDQsSkOov-bIE_8Aw/featured) for walkthroughs, courses, talks, workshops & more.
* [Follow us on Twitch](https://www.twitch.tv/onesignaldevelopers) for live streams, office hours, support & more.

### Ask a question about OneSignal

You can  [Ask a question 🙋‍♂️](https://github.com/OneSignal/onesignal-node-api/issues/new?assignees=&labels=triage&projects=&template=ask-question.yml&title=%5Bquestion%5D%3A+) about the OneSignal Node SDK and related topics in the **onesignal-node-sdk** repository.

### Create a bug report

If you receive an error message or get blocked by an issue, please [Create bug report 🪳](https://github.com/OneSignal/onesignal-node-api/issues/new?assignees=&labels=bug%2Ctriage&projects=&template=bug-report.yml&title=%5BBug%5D%3A+).

onesignal-node-sample

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README