openedx / openedx-events

Open edX events from the Hooks Extensions Framework
Apache License 2.0
11 stars 21 forks source link

State of the art repository to exemplify usage #359

Open mariajgrimaldi opened 2 months ago

mariajgrimaldi commented 2 months ago

Description

To aid developers in understanding and effectively utilizing the events library, we propose creating a state-of-the-art repository. This repository will serve as a comprehensive example, showcasing various use cases in different scenarios.

Expected Result

Key Components

  1. Comprehensive Examples:

    • Include a variety of examples demonstrating different use cases for the events library.
    • Cover basic to advanced scenarios, ensuring a wide range of applications are addressed.
  2. Detailed Documentation:

    • Provide clear and thorough documentation within the repository, including a README file that outlines the purpose and structure of the repository.
    • Include comments within the code to explain the functionality and purpose of each example.