Developer Docs

Note

This page is for developers who want to customize or extend OpenWISP Notifications, whether for bug fixes, new features, or contributions.

For user guides and general information, please see:

• General OpenWISP Quickstart

• OpenWISP Notifications User Docs

• Developer Installation Instructions
  • Installing for Development
  • Alternative Sources
• Code Utilities
  • Registering / Unregistering Notification Types
• Notification Cache
  • Cache Invalidation
• Extending openwisp-notifications
  • 1. Initialize your custom module
  • 2. Install openwisp-notifications
  • 3. Add EXTENDED_APPS
  • 4. Add openwisp_utils.staticfiles.DependencyFinder
  • 5. Add openwisp_utils.loaders.DependencyLoader
  • 6. Inherit the AppConfig class
  • 7. Create your custom models
  • 8. Add swapper configurations
  • 9. Create database migrations
  • 10. Create your custom admin
  • 11. Create root URL configuration
  • 12. Create root routing configuration
  • 13. Create celery.py
  • 14. Import Celery Tasks
  • 15. Register Template Tags
  • 16. Register Notification Types
  • 17. Import the automated tests
  • Other base classes that can be inherited and extended

Other useful resources:

• REST API

• Settings