CSC/ECE 517 Spring 2016/Badging System - Revision history

Skataka: /* Database Design */

2016-04-26T14:56:49Z

Database Design

← Older revision		Revision as of 14:56, 26 April 2016
Line 160:		Line 160:
	\|-		\|-
	\| is_course_badge \|\| boolean \|\| Whether badge is a course-badge or individual-badge		\| is_course_badge \|\| boolean \|\| Whether badge is a course-badge or individual-badge
			\|-
			\| badges_awarded \|\| boolean \|\| Tells whether badges were awarded or yet to be awarded
	\|}		\|}

Magoff2: Added the rest of walkthrough

2016-04-25T22:33:16Z

Added the rest of walkthrough

← Older revision		Revision as of 22:33, 25 April 2016
Line 217:		Line 217:

	[[File:badges_new.jpg]]		[[File:badges_new.jpg]]

			Under assignment configuration, instructors may add badges to an individual assignment. They may choose to add the badges to the top N students, or based off of a given threshold. In order to see the previously mentioned strategies, Enable Badges must be checked. When enabling badges, it will create data in the badges_group and assignments_group tables.

			[[File:assignment_badges_config.jpg]]

			After badges are awarded, an instructor may view the badges given to students on the leaderboard page. On the leaderboard page each course has it's own board of students. Instructors may also manually award badges to students from the page.

			[[File:leaderboard_instructor.jpg]]

			Upon clicking award badge you will be brought to a form, which contains the student, the badge and the assignment. After submitting the form a badge will be awarded to the student by creating an entry in the badges_users table.

			[[File:award_badges.jpg]]

			===Student===
			Students may view the leaderboard for classes they have taken. They may see where they place among their peers.

			[[File:student_leaderboard.png]]

	==Mockups==		==Mockups==

Dasoni: /* Tasks To Do */

2016-04-25T15:35:30Z

Tasks To Do

← Older revision		Revision as of 15:35, 25 April 2016
Line 55:		Line 55:
	**# Select Save		**# Select Save

	===Tasks ~~To Do~~===		===Tasks Done===
	*Create db table to store the participants with badges.		*Create db table to store the participants with badges.
	*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.		*Write code for calling the service and calculating/identifying badges based on the scores of students on all assignments.

Dasoni: /* Files Used */

2016-04-25T15:35:01Z

Files Used

← Older revision		Revision as of 15:35, 25 April 2016
Line 82:		Line 82:
	**app/models/assignment_form.rb 4		**app/models/assignment_form.rb 4
	**app/models/assignment.rb 4		**app/models/assignment.rb 4
	**app/views/leaderboard/index.html.erb		**app/views/leaderboard/index.html.erb 4
	**app/views/leaderboard/~~_top3LeaderBoards~~.html.erb		**app/views/leaderboard/_leaderBoards.html.erb 4
	**app/views/leaderboard/_achievementLeaderBoards.html.erb		**app/views/leaderboard/_achievementLeaderBoards.html.erb
	**app/views/course/edit.html.erb		**app/views/course/edit.html.erb
Line 110:		Line 110:
	**app/views/assignments/edit/_select_badge.html.erb 4		**app/views/assignments/edit/_select_badge.html.erb 4
	**app/helpers/credly_helper.rb 4		**app/helpers/credly_helper.rb 4


	===Deciding External Web Service===		===Deciding External Web Service===

Dasoni at 15:31, 25 April 2016

2016-04-25T15:31:21Z

← Older revision		Revision as of 15:31, 25 April 2016
Line 68:		Line 68:
	#Discretionary merit badges for projects that exceed expectations.		#Discretionary merit badges for projects that exceed expectations.

	===Files ~~Identified~~===		===Files Used===
			Files that are modified or are added can be found [http://github.com/expertiza/expertiza/pull/673/files here]

	*Modified files:		*Modified files:
	**app/controllers/student_task_controller.rb		**app/controllers/student_task_controller.rb 4
	**app/controllers/users_controller.rb		**app/controllers/users_controller.rb 4
	**app/models/user.rb		**app/controllers/tree_display_controller.rb 4
			**app/controllers/leaderboard_controller.rb 4
			**app/controllers/assignments_controller.rb 4
			**app/models/user.rb 4
			**app/models/leaderboard.rb 4
			**app/models/badge_user.rb 4
			**app/models/assignment_form.rb 4
			**app/models/assignment.rb 4
	**app/views/leaderboard/index.html.erb		**app/views/leaderboard/index.html.erb
	**app/views/leaderboard/_top3LeaderBoards.html.erb		**app/views/leaderboard/_top3LeaderBoards.html.erb
	**app/views/leaderboard/_achievementLeaderBoards.html.erb		**app/views/leaderboard/_achievementLeaderBoards.html.erb
	**app/views/course/edit.html.erb		**app/views/course/edit.html.erb
	**config/routes.rb		**app/views/tree_display/actions/_courses_actions.html.erb 4
			**config/routes.rb 4
			**db/schema.rb 4
			**app/views/leaderboard/view.html.erb 4
			**app/views/auth/_login.html.erb 4
			**app/views/assignments/edit.html.erb 4
			**app/helpers/leaderboard_helper.rb 4
			**app/helpers/assignment_helper.rb 4




	*Newly added files:		*Newly added files:
	**app/models/~~badges~~.rb		**app/models/badge.rb 4
	**app/models/badge_groups.rb		**app/models/badge_groups.rb 4
	**app/controllers/badges_controller.rb		**app/models/assignment_group.rb 4
	**app/controllers/badge_groups_controller.rb		**app/controllers/badges_controller.rb 4
	**app/views/users/credly_register.html.erb		**app/controllers/badge_groups_controller.rb 4
	**app/views/assignments/edit/~~_badges_configuration~~.html.erb		**app/views/users/credly_register.html.erb 4
	**app/views/badges/		**app/views/assignments/edit/_badges.html.erb 4
			**app/views/badges/ 4
			**app/views/badge_groups/ 4
			**app/views/assignments/edit/_select_badge.html.erb 4
			**app/helpers/credly_helper.rb 4


	===Deciding External Web Service===		===Deciding External Web Service===

Magoff2: Started screenshot walkthrough

2016-04-25T14:15:55Z

Started screenshot walkthrough

← Older revision		Revision as of 14:15, 25 April 2016
Line 179:		Line 179:

	[[File:badging_class_diagram.png]]		[[File:badging_class_diagram.png]]

			==Walkthrough==
			Below is a walkthrough of the changes to implement the Badging System:
			===Instructor===
			Instructors may configure badges on the course page using the new badge configuration icon:

			[[File:Manage_courses_badges.jpg]]

			Upon clicking the badge configuration icon, the user will be presented with two items: create groups and view all existing groups. Users may also edit and delete groups. A group is a set of assignments to present badges for.

			[[File:badges_configuration.jpg]]

			A new group may be created using the form below. This form allows instructors to create a new badge while creating a group for which they will be redirected to Credly. The form page must be refreshed upon creating a new badge so it may appear in the interface. The result of this form will create a new record in badge_groups and assignment_groups tables.

			[[File:badges_new.jpg]]

	==Mockups==		==Mockups==

Dasoni at 16:50, 24 April 2016

2016-04-24T16:50:24Z

← Older revision		Revision as of 16:50, 24 April 2016
Line 114:		Line 114:
	! Column !! Type !! Comment		! Column !! Type !! Comment
	\|-		\|-
	\| ~~badge_id~~ \|\| int \|\| Primary key. Auto-generated		\| id \|\| int \|\| Primary key. Auto-generated
	\|-		\|-
	\| name \|\| ~~string~~ \|\| Description of the badge		\| name \|\| varchar \|\| Description of the badge
			\|-
			\| credly_badge_id \|\| int \|\| Corresponding badge id with Credly
	\|}		\|}

Line 124:		Line 126:
	! Column !! Type !! Comment		! Column !! Type !! Comment
	\|-		\|-
	\| ~~badge_user_id~~ \|\| int \|\| Primary key. Auto-generated		\| id \|\| int \|\| Primary key. Auto-generated
	\|-		\|-
	\| badge_id \|\| int \|\| Referenced from badges table		\| badge_id \|\| int \|\| Referenced from badges table
Line 142:		Line 144:
	! Column !! Type !! Comment		! Column !! Type !! Comment
	\|-		\|-
	\| ~~badge_group_id~~ \|\| int \|\| Primary key. Auto-generated		\| id \|\| int \|\| Primary key. Auto-generated
			\|-
			\| strategy \|\| varchar \|\| Describes the strategy of awarding
			\|-
			\| badge_id \|\| int \|\| Assigned badge id.
			\|-
			\| course_id \|\| int \|\| Course for which group is formed.
	\|-		\|-
	\| ~~strategy~~ \|\| ~~string~~ \|\| ~~Describes the strategy of awarding~~		\| is_course_level_group \|\| boolean \|\| Whether group is for course
	\|-		\|-
	\| threshold \|\| int \|\| Score required to award the badge		\| threshold \|\| int \|\| Score required to award the badge
Line 154:		Line 162:
	! Column !! Type !! Comment		! Column !! Type !! Comment
	\|-		\|-
	\| ~~assignment_group_id~~ \|\| int \|\| Primary key. Auto-generated		\| id \|\| int \|\| Primary key. Auto-generated
	\|-		\|-
	\| badge_group_id \|\| int \|\| Referenced from badge_groups table		\| badge_group_id \|\| int \|\| Referenced from badge_groups table

Dasoni: /* System Requirements */

2016-04-12T03:04:15Z

System Requirements

← Older revision		Revision as of 03:04, 12 April 2016
Line 8:		Line 8:
	==Requirements==		==Requirements==
	===System Requirements===		===System Requirements===
	The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. An instructor can also create badges anytime and award to students. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.		The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. An instructor can also create new badges anytime and award to students. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

	The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.		The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.

Dasoni: /* System Requirements */

2016-04-12T03:03:38Z

System Requirements

← Older revision		Revision as of 03:03, 12 April 2016
Line 8:		Line 8:
	==Requirements==		==Requirements==
	===System Requirements===		===System Requirements===
	The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.		The system requirements focuses on adding a 'badging' functionality in Expertiza. This feature allows instructors to assign badges to students based on their performance and accomplishments. Badges are of types - course-level and assignment-level. Badges can be pre-selected while creating an assignment and automatically triggered when student finished the assignment or assignment is closed. Badges can also be awarded manually by instructor to an individual or a team. An instructor can also create badges anytime and award to students. A leaderboard gives an account of standing of students in terms of badges earned. In order to implement a badging system, a third party badge manager will be utilized called Credly. Credly provides a way for users to accumulate and display badges they earn in a centralized way. By utilizing Credly, the development of the actual badges and badge management can be abstracted away from the project.

	The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.		The testing of these requirements will use Rspec testing framework for all non-user interface related modifications. All user-interface modifications resulting from the user requirements will be tested manually.

	===Use Case===		===Use Case===
	The following simple illustration shows the use cases of the system.		The following simple illustration shows the use cases of the system.

Dasoni: /* Use Cases */

2016-04-12T02:58:51Z

Use Cases

← Older revision		Revision as of 02:58, 12 April 2016
Line 16:		Line 16:
	[[File:Use_case.PNG]]		[[File:Use_case.PNG]]

	====Use ~~Cases~~====		====Use Case Scenarios====
	* '''Student Views Leaderboard'''		* '''Student Views Leaderboard'''
	** Actor: Student		** Actor: Student