thekeenant / madgrades.com

Frontend for visualizing UW Madison course grade distributions.

Home Page:https://madgrades.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

madgrades.com Build and deploy to prod

The source for madgrades.com, a web interface for visualizing the data provided by the Madgrades API [source]. Get it yourself, or visit the official website at madgrades.com!

Usage

It's easy to run your own madgrades interface, it's just a React app.

Requirements:

  • Node (npm)
  • That's it.

Steps:

  1. Get the required dependencies, npm install.

  2. Get a Madgrades API token from api.madgrades.com.

  3. Create a .env.development file with the following:

    REACT_APP_MADGRADES_API='https://api.madgrades.com/'
    REACT_APP_URL='https://madgrades.com'
    REACT_APP_MADGRADES_API_TOKEN='<your api token>'
    REACT_APP_GA_TRACKING_ID=''
    

    Make sure to set your api token to your own.

  4. Run the development server with npm start.

Create a production-ready app with npm run build. Instead of a .env.development file, you will need .env.production with the same contents, assuming you are using the same key for production and development.

Example Page

This is a course page:

Madgrades Picture

About

Frontend for visualizing UW Madison course grade distributions.

https://madgrades.com

License:MIT License


Languages

Language:JavaScript 94.3%Language:SCSS 3.4%Language:HTML 2.0%Language:Shell 0.3%