Add admin-only Notes feature for courses #5650
Conversation
…ble_redux' This commit introduces a new notes editor component. The 'toggleEditable' prop is passed from the 'editable_redux' module, enabling dynamic control over the editor's editability state.
This commit adds the 'NotesList' component responsible for rendering a list of notes, and the 'NotesRow' component for displaying individual note items within the list.
This commit adds the 'NotesPanel' component, responsible for managing a panel displaying notes for a course. It fetches and updates the list of notes and includes an edit button. The 'NotesPanelEditButton' component is introduced to handle creating new and deleting individual notes within the panel.
This commit introduces the 'NotesHandler' component, responsible for managing the display and interaction flow of course notes. It utilizes state management to handle different modal types, allowing users to view and edit course notes. The component includes integration with 'NotesPanel' and 'NotesEditor' for displaying notes and enabling note editing, respectively.
This commit adds state management functionality for course notes in the 'NotesHandler' component. The state allows for dynamic control and interaction with course notes, enhancing the overall course notes management capabilities.
This commit adds functions for fetching, saving, creating, and deleting course notes in the 'api.js' file. The new methods include 'fetchAllCourseNotes', 'fetchCourseNotesById', 'saveCourseNote', 'createCourseNote', and 'deleteCourseNote'. These functions provide the necessary API calls to interact with course notes, enabling full CRUD functionality within the application.
This commit introduces CRUD routes for Course Notes in 'routes.rb' and implements corresponding actions in 'CourseNotesController'. Additionally, the 'CourseNote' model is updated to include validations and methods for creating and updating notes. These changes collectively enable the full range of Create, Read, Update, and Delete (CRUD) operations for Course Notes within the application.
Also added comments to course_notes_action
Separated the CSS for admin only notes to a new file
From AdminQuickAaction only admin notes will be available to a admins and if the admin is staff too then all the all the AdminQuickActions are visible.
|
@ragesoss could you please review my code whenever you are free? Still working on the test code for this feature. Thanks! |
This commit adds a comment to clarify the role and purpose of the modalType variable in the code.
Test code for Admin only notes feature.
|
When I create a note, I get this error: |
|
Actually, that error happens after the server returns a 422. It looks like this is because 'edited by' is blank. But the frontend should render an error notification if there's an error response returned by the server. |
| end | ||
|
|
||
| def create | ||
| note_details = CourseNote.new.create_new_note(course_note_params) |
There was a problem hiding this comment.
This is not the idiomatic Rails way to create a new record. If you do CourseNote.create(attrributes) instead, it will return a CourseNote note object which you can check for validation errors (by calling .errors on it). Or you can do CourseNote.create! and it will raise those errors directly so that you can rescue them and return an appropriately detailed error response.
Abishekcs
changed the title
@ragesoss I am also thinking of an expanded accordion for creating new notes within the same table instead of opening a new table. Or would it be better if creating a note opens a new table entirely? |
I think it will be very rare for a course to have more than one or two notes, so I think keeping the same table and creating a new note within it as you propose will be a good option. |
Okay, great. I will make the changes to the UI according to this. |
|
@ragesoss, I've made some changes to the UI. Below is a recording showcasing the updates. It's still a 2024-04-09.20-22-00.mp4 |
|
@Abishekcs yeah, I like this! |
Update method of course notes controller now returns the updated course note details.
Update the existing AdminNote frontend code to align with the recent UI changes to the application.
Update Redux reducers and actions to align with the recent UI changes to the application.
Update test cases for the course note reducer and action to ensure compatibility with recent changes.
|
@ragesoss I have used the convention as precisely as possible, though there might be some minor changes. However, BEM can be used as a starting point - https://cssguidelin.es/#bem-like-naming Additionally, I have changed the table name from I would really appreciate if you could kindly review the code and UI. Please let me know if any further changes are required. Thank you. Demo.1.mp4 |
Abishekcs
changed the title
|
@ragesoss any update on this PR? |
|
@Abishekcs not yet, but it's on my todo list! |
closes #5526
What this PR does
Enable only
Adminstocreate, edit, read and deleteCourse NotesScreenshots
Before:
Before.mp4
After:
Demo.1.mp4