@notificationapi/react
v0.0.37
Published
[![NotificationAPI](./ReadmeLogo.svg)](https://notificationapi.com)
Downloads
3,669
Readme
The React SDK is mainly used for displaying In-App Notifications, allowing users to see and change their Notification Preferences and enabling web push notification .
Docs
Please refer to our documentations.
Development
- Install dependencies:
npm install
- Run the example application:
npm run dev
React + TypeScript + Vite
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Currently, two official plugins are available:
- @vitejs/plugin-react uses Babel for Fast Refresh
- @vitejs/plugin-react-swc uses SWC for Fast Refresh
Expanding the ESLint configuration
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
- Configure the top-level
parserOptions
property like this:
export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname
}
};
- Replace
plugin:@typescript-eslint/recommended
toplugin:@typescript-eslint/recommended-type-checked
orplugin:@typescript-eslint/strict-type-checked
- Optionally add
plugin:@typescript-eslint/stylistic-type-checked
- Install eslint-plugin-react and add
plugin:react/recommended
&plugin:react/jsx-runtime
to theextends
list
Contributing
We welcome contributions! To ensure smooth collaboration, please follow these steps:
Clone the Repository
Fork the repository to your GitHub account.
Clone it to your local machine:
git clone https://github.com/your-username/repo-name.git cd repo-name
Create a Branch
Create a new branch for your changes:
git checkout -b your-branch-name
Make Your Changes
- Make your changes in the relevant files.
- Thoroughly test your changes to ensure they work as expected.
Versioning
Before committing your changes, update the package version by running:
npm version <type>
Versioning Types:
- major: For breaking changes or large-scale features.
- minor: For adding functionality in a backwards-compatible manner.
- patch: For backwards-compatible bug fixes or small improvements.
For example, to update a patch version:
npm version patch
Commit and Push
Once you’ve made and tested your changes, commit them with a meaningful message:
git add . git commit -m "Describe your changes"
Push your branch to GitHub:
git push origin your-branch-name
Submit a Pull Request
- Create a pull request (PR) on GitHub.
- Provide a clear description of what your changes do.
- Link any relevant issues.
Update Documentation
- If your changes affect the documentation, please update it accordingly.
- You can find the documentation repository here: NotificationAPI Docs.
Thank you for contributing!