acmutd / utd-grades

A tool to view grade distributions at UT Dallas.

UTD Grades

UTD Grades is an application for viewing grade distributions at UT Dallas.

Components

This monorepo consists of two sub-projects.

• The client project contains the application itself, built with React and Next.js.
• The db project contains everything related to the SQLite database that powers the app.

There is also a raw_data folder that contains all currently received grade data in CSV format.

Each component as a dedicated readme, and the architecture document describes how everything fits together.

Development

Due to some changes with the fetch API in Node v18 and sql.js not handling those changes, please use Node v17.
Install and switch between multiple node versions with nvm.

We make use of NPM workspaces to simplify development in the monorepo. To get started developing locally, simply clone this repository run the following commands...

1. npm install - install dependencies
2. npm run dev - create the SQLite database from the raw data and then launch the Next.js development server

Deploying

The project builds to a completely static web bundle, making it deployable pretty much anywhere. Simply run npm run build, and deploy the resulting client/out directory wherever you want.

Testing deployment locally

You can easily test the deployment locally using a package like http-server. After running npm run build, run npx http-server out/client.

Deploy to GitHub Pages

We have a workflow that automatically deploys the main branch to GitHub Pages.

Uploading New Data

Just add the data in CSV format to the raw_data directory (be sure to remove any lines before the header) and rebuild/redeploy.

utd-grades's Issues

Migrate UTD Grades from AWS to Google Cloud deployment

Overview

Right now, the UTD Grades back-end functions are deployed to AWS Lambda using the acmutdlabs AWS root account. However, all other Project Nebula products use Google Cloud Platform, which integrates with our existing IAM solution (Google Workspace). Although UTD Grades is soon to be deprecated, it may need to exist in a backup form for our intended March 25, 2022 target for its deprecation and may need to stay up. Furthermore, redeploying to Google Cloud may give us the opportunity to reduce costs in the meantime, which may give more funding to other parts of the Project Nebula budget. As such, we should redeploy the service to use GCP resources.

Tasks

• Ensure that the UTD Grades backend is properly containerized
• Deploy the UTD Grades functions container to Google Cloud Run or equivalent
• Configure settings to auto-scale the container to reduce resource usage when client request volume is low

Dark mode

I think we should assign @NickBurnett

Handle UTD Grades Deprecation

Overview

TL;DR: We're building an expanded service for UTD-related data - the Nebula Data Service. UTD Grades will remain accessible, but the new dashboard will include more information than purely grades.

Timeline

• #18
• UTD Grades will be deprecated on October 13, 2021
• UTD Grades will be fully retired in spring 2022
  • utdgrades.com will redirect to grades.utdnebula.com or whatever will be the chosen route for grades data

Update UTD Grades data for fall 2020, spring 2021, and summer 2021 semesters

Overview

The UTD Grades database needs to be updated to display grade distributions for fall 2020, spring 2021, and summer 2021 data. Using the data that @Tmtomer and the Mercury have obtained using a Freedom of Information Act request, follow the repository's documentation on uploading the grades data to the database on AWS that currently stores grades data.