Monash Grades Calculator

A simple calculator that helps Monash University students track their academic progress

⚠️ This is not an official Monash University tool

Try it out · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Why This Calculator
   • Official Monash References
   • Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Known Issues
4. Contributing
5. License

About The Project

Using Monash's official calculation methods, this calculator computes both your GPA and WAM in one place.

Why This Calculator

The existing separate calculators for GPA and WAM require students to input their results multiple times. This calculator was created to provide a streamlined experience where you can:

• Calculate both GPA and WAM simultaneously
• Import results directly via CSV
• See calculations update in real-time

Official Monash References

• Results and Grades Legend
• GPA Calculation Method
• WAM Calculation Method

Features

• Real-time GPA and WAM calculations
• CSV result import support
• Manual grade entry
• User-friendly interface
• Privacy-focused (all calculations performed locally)

Built With

(back to top)

Getting Started

This guide will help you set up the app locally on your machine. Follow these simple steps to get a local copy up and running.

Prerequisites

Make sure you have Node.js (version 20 or higher) installed on your system. You can download it from nodejs.org.

• npm (usually comes with Node.js)

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/ligsnf/monash-grades-calculator

2. Navigate to the project directory

   cd monash-grades-calculator

3. Install NPM packages

   npm install

4. Start the development server

   npm run dev

5. Open your browser and navigate to the URL shown in the terminal (usually http://localhost:5173/monash-grades-calculator/)

(back to top)

Known Issues

• Due to GitHub Pages hosting limitations, direct navigation to routes (e.g., /about) will trigger a 404 error. A redirect has been implemented to handle this by returning users to the homepage.
• In iOS Safari, the site icon may revert to a default letter when navigating between pages. This is a known Safari limitation with Single Page Applications (SPAs), affecting many web applications, and is not specific to this calculator.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

(back to top)

License

Distributed under the GNU GPLv3 License. See LICENSE for more information.

(back to top)