User Documentation

Our Development unit common landing page: https://unit5-welcomepage.herokuapp.com/. Click on Students.

Our application hosted at: https://frontend-take2-murmur.herokuapp.com/#/

This is the user documentation of our application. We are going to walk you through the entire process of how a student can add themselves to our system. After that, they can assign themselves to a coop. Once they do that, they are taken to their dashboard. During the course of their coop, they are required to submit 3 forms: the initial report form, the technical report form and the evaluation form. The student can check their progress at any time during the coop. Once a student is added to our system, they can also log back in as a returning user.

Step 1: Welcome Page

This allows you to specify if you are a new student or a returning student. Click "Yes, I am" to add yourself to the system.

Step 2: Add Student

Add in your details to add yourself to the system. Your McGill ID is the unique identifier that identifies you. Click "Add Me".

Step 3: Add Coop

Add in your coop details. We assume that you have already received the coop offer outside of our cooperator system (maybe through myfuture). Through our system, you just need to add in the coop details. Again, the coopID is the unique identifier that identifies your particular coop. Click "Add Coop".

Step 4: The DashBoard

Now you are on the Dashboard. You know it's your personal dashboard since you can see your name at the top left and your id at the top right. From the dashboard, you can fill in your initial report form, your technical report form and the evaluation form. You can check your progress at this point and it should be 25%.

Step 5: Initial Report

After you've had your fun with the dashboard, now it's time to fill in your initial report. Fill in the required details and click Submit. You'll be redirected back to the dashboard where if you check your progress, it's going to be 50%.

Step 6: Technical Report

The second step throughout the course of the coop is to fill out the technical report form. Click submit after you've done so and then if you check your progress, it's going to be 75%.

Step 7: Evaluation Form

To complete your coop, you need to submit the evaluation form. Again, you'll have a bunch of fields to fill in. After you've done this step, click submit and check your progress. Voila. It is 100%. Congratulations. You've finished your coop.

Step 8: View Coop

Now you click "View Coop". Your coopID will already be pre-filled in for you. Click submit and wait a few seconds. Heroku takes up some time but it will return to you all of the documents you have submitted. That ways, you can keep track of everything you've submitted to our system up until now.

Step 9: Returning Student

The final feature of our website will take you back to the main screen. Click "Main Screen" and click "No, not really" to indicate that you are not a new student. Enter your McGill ID that you used to add your self to our system and click "Go to my dashboard". You'll be redirected to your dashboard where you can edit the documents you've submitted (by submitting new docs) and check your progress again. Currently these are all the functionalities that are supported by our system.