https://github.com/pod-point/notifications-js
A notification service for JS applications.
https://github.com/pod-point/notifications-js
software-team
Last synced: 10 months ago
JSON representation
A notification service for JS applications.
- Host: GitHub
- URL: https://github.com/pod-point/notifications-js
- Owner: Pod-Point
- License: mit
- Created: 2019-12-30T13:44:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-24T07:17:50.000Z (almost 4 years ago)
- Last Synced: 2025-08-03T05:51:31.839Z (11 months ago)
- Topics: software-team
- Language: TypeScript
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Notifications JS
[](https://travis-ci.com/Pod-Point/notifications-js)
[](https://codecov.io/gh/Pod-Point/notifications-js)
A notifications service for JS.
## Usage
To install this package, run the following command:
```bash
npm install @pod-point/notifications-js
```
Once installed, simply create a new instance of the Notifications service and begin using it e.g.
```js
import { SNS } from '@pod-point/notifications-js';
const notificationService = new SNS();
const notification = await notificationService.publish('message', 'topic');
```
## Development
### Installation
To install this packages dependencies, run the following command:
```bash
npm install
```
### Testing
This package uses jest. To run the test suites for this project, run the following command:
```bash
npm run test
```
### Releases
This package is distributed via NPM and published automatically by Travis when creating a tagged commit. This can be done in one of 2 ways:
#### 1. Pre-merge via the CLI
**Before** merging your PR following code review & QA, run the following commands to update the package version and create a new release/tag.
```
npm version
git push && git push --tags
```
If you forget to do this before merging, this is not a problem, just create a new branch from master and run these same commands, remembering to open and merge a PR for this branch so that the `package.json` file is updated, alternatively, see option 2.
#### 2. Post-merge via code & GitHub
**After** merging your code changes, create a new branch/PR from master and update the package version in `package.json` to whatever you wish the next release to be.
**Before** merging this PR, create a release via GitHub with a tag version to match this package version number, this will trigger the tagged commit and in turn the automatic deployment to NPM.