Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 2.12 KB

README.md

File metadata and controls

71 lines (45 loc) · 2.12 KB

Perfecty Push JS SDK

tests deployment License

Javascript SDK for Perfecty Push, a self-hosted Push Notifications server written in Go.

You can use this client library to include Push Notifications in your website for free. WordPress is also supported. More information on the main project:

NOTICE: This project is under active development and no API is stable yet.

Perfecty Push for Wordpress

Local Setup 👨🏻‍💻

This project uses:

  • Babel with @babel/preset-env
  • Jest for unit testing
  • Browserlistrc to specify dynamic Browser compatibility
  • ESLint using the Standard style
  • Webpack 5

To run the development server:

npm install
npm start

To run the build with watch in WordPress:

npm run watch

To generate the minified SDK in dist/:

npm build

Unit tests 🧪

Run all the tests using jest:

npm test

License 💡

This project is licensed under MIT.

The bell icon SVG code is a Font Awesome icon under MIT License.

Collaborators 🔥

rwngallego
Rowinson Gallego

Special Thanks

Jetbrains

Thanks to Jetbrains for supporting this Open Source project with their magnificent tools.