User Guide

Account Creation

1. Press the sign in button on the top right hand side of the landing page, which will bring you to the sign in page.

2. Press the create account link.

3. Complete the sign-up form with your personal details, including name, email address, and any other required information.

4. Wait for account to be approved by an administrator.

5. Log in to your account with your email and password.

Course Management

1. Once signed in, click on the course you want to manage, or create a new course.

Course Creation

1. To create a new course, click on the Create Course button.

2. Fill in the course details such as course code, title, semester, and description. For the course type, choose GitHub Organisation if you want GitHub statistics, else choose normal.

3. To create a GitHub Organisation course, install the GitHub app on your GitHub Organisation

4. Enter your GitHub Organisation name, and press the Check Installation button.

5. If the organisation name is valid, a text field for the Repo Name filter will appear. Enter the string you that you want to filter the repos by.

6. Press the Create Course button to confirm, and it will direct you to the course page if successful.

People Management

1. Within your course dashboard, click on the "People" tab to manage course participants.

2. To add new participants, click on the 'Add Faculty', 'Add TA', or 'Add Student' button.

3. In all of the forms, to add a participant individually, enter the details of the participant and press the 'Create X' button.

4. To add participants in bulk, press the Download CSV template.

5. Fill up the template with the participants details.

6. Click on the drop zone and upload the populated csv file.

7. Press the 'Upload X' button to add the participants in the course.

8. To manage course participants, press the 'Edit Details' button.

9. You can now remove course participants, or edit their details.

Team Management

1. Within your course dashboard, click on the "Teams" tab to manage course teams.

2. Press the "Create TeamSet' button, and fill in the name of the team set.

3. Press the "Assign Students' button to assign students into the team.

4. This can be done individually, or in bulk through a CSV upload.

5. Repeat steps 3 to 4 for assigning of TAs.

6. Press the 'Edit Teams' button to edit teams.

Assessment Management

1. Within your course dashboard, click on the "Assessments" tab to manage course assessments.

2. Click on the Assessment you want to manage, or create a new Assessment.

3. In the Assessment creation form, fill up the assessment details.

4. Choose a Team Set for the result and groups to be populated with the Team Set data.

5. Form link is the url of the google form.

6. Sheet ID is the ID of the google sheets, obtained from the google sheets url. An example is shown below:

7. Sheet Tab is the name of the tab of the google sheet you want to use. An example is shown below:

8. Press the Create Assessment button to create a single assessment, or you can do so in bulk by downloading the CSV template.

9. In the Assessment view, to populate the submission data, press the 'Update Sheets Data' button.

10. Permission must be given to the service account in the google sheets to allow CRISP to fetch the data.

11. 'Team', 'Comments' must be column headers for team assessments, while 'Identifier', 'Name', 'Team', 'Comments' must be column headers for individual assessments.

12. Press the "Evaluate" tab on the top to view the embedded google form.

Project Management

Jira

1. "Authorize with Jira" redirects to Atlassian login page for authorization.

2. After authorization, wait for the next day for Jira data to be fetched.

3. Go to "Teams" page to assign project boards to each team.

Trofos

1. "Authorize with Trofos" requires Course ID and API Key fields.

2. On another browser window, login to Trofos and obtain these 2 fields.

3. Input the 2 fields to authorize CRISP to fetch Trofos data.

4. Wait for the next day for Trofos data to be fetched.

5. Go to "Teams" page to assign project boards to each team.

GitHub Projects

1. During course creation, select a GitHub Organization.

2. Wait for the next day for GitHub Projects data from the GitHub Organization to be fetched.

3. Go to "Teams" page to assign project boards to each team.