The University of Melbourne WinterHack 2021

• Team Members
• Link to our website
• General Info
• Detailed Info
• Frameworks and tools
• Instructions of Using code
• Test account
• How to access our database
• How we achieve our calculation process
• Future Improvement
• Image Reference
• Link To the Presentation Video

contributor:

• Yu-Wen Michael Zhang: yuwenmichael
  
• Hu Chen: Prestonccc
  
• Nuoda Yang: NuodaY
  
• Yifei Wang: andyfadai, shahuhuyifei (Yifei has two accounts)
  

main page: https://winterhack-valkyrie.herokuapp.com

Promotional Video: https://youtu.be/C8UdwksDbeI
Presentation: https://youtu.be/-Pkdv0b_HPw

The website we developed in this project is mainly used to calculate the score that the user need to achieve in every assignment based on a target overall score the user set in the application.

• This website needs user to login and register so that the user can access the full functionalities. We use passport.js to authenticate user and use bcrypt to encrypt user's password, which makes our website more securer.
  

• NodeJs 14.16.X
• MongoDB Atlas
• Heroku
• Handlebar

Clone this repository and install all the dependencies in package.json and type npm start in terminal to run the code. However, you may not be able to run these codes because you cannot access our database. If you intend to do so, we have provide one of our username and password. And you will need to set a passport key, which could be anything you want. Please refer to here: How to access our database.

Account email: [email protected]
Account password: test12345

We use MongoAtlas to store user information.
Here is our mongoDB connection string:
mongodb+srv://Michael:[email protected]/WAM_Calculator?retryWrites=true&w=majority
You can download MongoDB compass and type this string to connect to our database. Our database name is: WAM_Calculator
Also, you will need to create a new file call .env in your local computer so that you can use our code. Please type the following code in this file:
MONGO_USERNAME=Michael
MONGO_PASSWORD=1234
PASSPORT_KEY=info30005secretkey
This PASSPORT_KEY will allow you to use passport.js while you try to run our code.

We calculate the sum of the user's known assignment scores and determine how close the user is to it based on the target score set by the user, and calculate how many points each assignment needs to earn on average to reach the target score among the unentered or upcoming assignment scores.

Let's say there are 3 assignments in total for a subject A, one of them is known. The other two of them will be estimated to see how the target can be reached:
A1: 20/30, A2: X/30, A3: Y/40, Target: 80,
where X is the estimated score of A2, Y is the estimated score of A3.

Step1: X+Y = Target-SumOfKnownScores = 80-20 = 60;
Step2: PercentageLeft = 100-TotalPercentageOfKnownScores = 100-30 = 70;
Step3: RatioA2 = PercentageA2/PercentageLeft = 30/70; RatioA3 = PercentageA3/PercentageLeft = 40/70;
Step4: X = RatioA2*(X+Y) = 3/7x60 = 25.71; Y = RatioA3*(X+Y) = 4/7x60 = 34.29;
Therefore, 25.71 and 34.29 are the estimated target for A2 and A3 computed by our calculator.

• Subject details (subject name, overall target score etc.) cannot be changed once you added the subject in homepage.
• Add overall WAM calculation based on the current added subjects in homepage.

The favicon image is from https://www.pinterest.com.au/pin/57350595241878813/.