Progress Report of Students.

[amarkrsinha1997]

Kamaladevi: This feature would help the mentors and other students to view the progress of their peers so they can view who is stuck where? who needs help and from whom they can seek help. Design: Notes

Part I

Understanding

• A mentor has 3-4 student assign under him.
• Each student submits an assignment in the course through which we judge the progress of the student on how many assignment have been submitted.
• The facilitator is treated as the mentor of the complete center.
• If a person is not a facilitator or a mentor an error is returned with 417 status code.

Part 2

• We need an Interface which shows the progress of the student on every course they are enrolled in or have completed.
• The progress can be calculated using the completedSubmission/totalExercises.
• API GET /reports/courses
• The JSON response it sends

  {
  "menteesCoursesReport": [
  {
    "courseId": 1,
    "courseName": "Basic Programming Using Python",
    "studentEnrolled": [
      {
        "totalExercises": 10,
        "menteeName": "Amar Sinha",
        "menteeEmail": "amar17@navgurukul.org",
        "menteeCourseStatus": "completed", // ["completed", "enroll", "unenroll"] contains one of them,
        "completedSubmissions": 3,
        "menteeId": 2,
      },
      {
        "totalExercises": 10,
        "menteeName": "Diwakar Prasad",
        "menteeEmail": "diwakar17@navgurukul.org",
        "menteeCourseStatus": "completed",  // ["completed", "enroll", "unenroll"] contains one of them,
        "completedSubmissions": 5,
        "menteeId": 4,
      }
    ]
  }
  ],
  "mentees": [
  {
    "id": 2,
    "name": "Amar Sinha",
    "email": "amar17@navgurukul.org"
  },
  {
    "id": 4,
    "name": "Diwakar Prasad",
    "email": "diwakar17@navgurukul.org"
  }
  ]
  }

Part 3

• Whenever a person clicks on the courses it should take him to a different interface which displays all the exercises with the submission status for the student.
• It should show as the wireframe down below.
• API GET /reports/course/{courseId}
• The JSON response it sends

  {
  "courseId": 39,
  "courseName": "Basic Programing Using Python",
  "courseType": "html",
  "courseLogo": "https://some-url-logo.png",
  "courseShortDescription": "A small description on the course",
  "menteesCoursesReport": [
          {
              "exerciseId": 1,
              "exerciseSlug": "slug_for__the-exercise",
              "exerciseSequenceNum": 1000,
              "exerciseName": "The Exercise",
              "exerciseSubmissionType": "url", // ['number','text','text_large','attachments','url']
              "exerciseGithubLink": "link to the Github Page",
              "exerciseContent": "content of the exercise",
              "submissions":[
                  {
                      "submissionId": 1,
                      "submissionState":"completed", // ['completed', 'rejected', 'pending']
                      "submissionCompleted": true,
                      "menteeId": 2,
                      "menteeName": "Amar Sinha",
                      "menteeEmail": "amar17@navgurukul.org",
                  },
                  {
                      "submissionId": 1,
                      "submissionState":"completed", // ['completed', 'rejected', 'pending']
                      "submissionCompleted": true,
                      "menteeId": 4,
                      "menteeName": "Diwakar Prasad",
                      "menteeEmail": "diwakar17@navgurukul.org",
                  },
              ]
          },
      ],
      "mentees": [
          {
              "id": 2,
              "name": "Amar Sinha",
              "email": "amar17@navgurukul.org"
          },
          {
              "id": 4,
              "name": "Diwakar Prasad",
              "email": "diwakar17@navgurukul.org"
          }
      ]
  }

Part 4

• A mentor or facilitator could mark the the course in which student has enrolled as completed.
• API POST /courses/{courseId}/complete
• Requires menteeId as a payload.
• Only mentors of the menteeId provided or the facilitator for the same center or all center can mark it as completed.
• Json response sent

  { "success" : true}

[amarkrsinha1997]

Todo

component 1 MenteeCourses

Route

• [x] http://saral.navgurukul.org/reports/courses

  Pages

• [x] API call in componentDidMount in courses component in reports module.
• [x] Put the table in state and then pass it into the component.
• [x] Create a function to arrange the data as a table.

  Edge Cases

• [x] Handle 417 if the user is not a mentor nor facilitator with some different UI.
• [x] Check if any student is enrolled in any course or not? Using the length of the course reports array.
• [x] Create UI for 417
• [ ] create UI show student doesn't have any courses.

  Component

• [x] A function that takes courseId and menteeId as argument calls the API to mark the course completed.
• [x] Create an HTML to show the data in the table using the grid or table.
• [x] Add Progress Bar with Percentage calculation using (completedSub/totalExercise * 100).
• [x] Show percentage in the title of the progress bar.
• [x] "My Mentees" as the title.
• [x] Add links to each course to open there exercises report page.
• [x] Error handle when marking any student course to be completed.
• [ ] popup to mark the course completed.
• [ ] update the state of mentee course status once his course is being marked completed.
• [ ] color the progress bar.
• [ ] show percentage in the title

Component 2 MenteeExercises

Pages

• [x] Call an API to get the detail of the courses.
• [x] Course Name on the top.
• [x] Get the courseId from the URL.

  Route

• [x] http://saral.navgurukul.org/reports/course?courseId=3&courseName="Basic Programming using Python"

Edge Cases

• [x] Handle 417 if the user is not mentor nor facilitator with some different UI.
• [x] Only student who has mentees can views this 2 API the backend return 417 status code if he doesn't have any mentee.
• [x] get the name out of backend and verify no one hits on the wrong URL.

Component

• [x] Create an HTML to show the data in the table.
• [x] Create a function to get a respective icon and also find suitable icons.
• [x] Get API colored.