django-notifications-views 0.2.1

Django-notifications-views is an extension for Django-notifications-hq that provides a viewset for the notifications.

Django-notifications-views

Django-notifications-views is an extension for Django-notifications-hq that provides a viewset for the notifications and expo notifications.

Requirements

• Django >= 3.8 *
• Python >= 3.8 *
• django-notifications-hq >= 1.8 *

(*) Not tested with earlier versions.

Quick Setup

Install package

pip install django-notifications-views

Add django_notifications_views app to INSTALLED_APPS in your django settings.py:

INSTALLED_APPS = (
    ...,
    "django.contrib.staticfiles",
    "rest_framework",  # required only if using the provided REST endpoints
    'notifications',
    'django_notifications_views',
     ...,
)

Include viewset routes

from django_notifications_views.urls import router as django_notifications_views_router
your_router.registry.extend(django_notifications_views_router.registry)

Add the following to your settings.py if you want to enable Expo Go notifications:

DJANGO_NOTIFICATIONS_VIEWS = {
    'USE_EXPO_NOTIFICATIONS': True, # Set to True to enable expo notifications
    'EXPO_APP_ID': '<your-expo-app-id>', 
}

Then run the migrations:

    python manage.py makemigrations
    python manage.py migrate


##  Urls

 GET /api/user-notifications/ : Get all notifications for the current user
 POST /api/user-notifications/read-all/ : Mark all notifications as read for the current user
 GET /api/user-notifications/<int:pk>/ : Get a notification by id and mark it as read

 # Expo Notifications
 POST /api/expo-devices/register-device/ : Register a device to receive expo notifications
 POST /api/expo-devices/unregister-device/ : Unregister a device to stop receiving expo notifications


## Contributing

-   [Juan Ignacio Borrelli](https://www.linkedin.com/in/juan-ignacio-borrelli/)
    

Maintained and developed by [Linkchar Software Development](https://linkchar.com/).