openimis-fe-grievance_social_protection_js

This documentation provides a comprehensive guide to the OpenIMIS Frontend Grievance module. The Grievance module is a deployable module for managing grievances within the OpenIMIS system. Below, you will find information on building, deploying, contributions, Redux actions, state bindings, and configuration options.

1. Building and Deploying

• The Grievance module is built using Rollup, a JavaScript module bundler.

• To build and deploy the module, refer to the openimis-fe_js repository and follow the instructions for development or server modes.

2. License

• The Grievance module is licensed under the AGPL v3 (GNU Affero General Public License, version 3).

• Ensure compliance with the AGPL v3 license when using or modifying the module.

3. Main Menu Contributions

• The module contributes to the OpenIMIS main menu with the Grievances tab.

4. Other Contributions

N/A

5. Available Contribution Points

• Dispatched Redux Actions:

  • GET_GRIEVANCE_CONFIGURATION_{REQ|RESP|ERR}:
    Triggered when fetching the grievance configuration.

  • GRIEVANCE_SOCIAL_PROTECTION_MUTATION_{REQ|RESP|ERR}:
    Triggered when performing a mutation related to social protection grievances.

  • RESOLVE_BY_COMMENT_{REQ|RESP|ERR}:
    Triggered when resolving a grievance by adding a comment.

  • REOPEN_TICKET_{REQ|RESP|ERR}:
    Triggered when reopening a previously closed grievance ticket.

  • CLEAR_TICKET_{REQ|RESP|ERR}:
    Triggered when clearing or closing a grievance ticket.

6. Other Modules Listened Redux Actions

• The Grievance module does not listen to Redux actions from other modules.

7. Other Modules Redux State Bindings

• The module binds to state.core.user to access user information, including rights and other relevant data.

8. Configuration Options

• The Grievance module does not provide specific configuration options.

For detailed implementation details, code examples, and usage guidelines, refer to the actual code files in the module's repository. Additionally, ensure compliance with the AGPL v3 license when using or distributing this module.