README.md

madgrades.com

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!

Docker instructions

1. Create a .env file based on the provided .env.example.
2. Build the Docker container

$ docker run --env-file .env -p 3000:3000 -it ghcr.io/madgrades/madgrades.com

You can now access the frontend from http://localhost:3000.

Alternatively, you can clone this repository and build the Docker image yourself:

$ docker build . -t madgrades.com
$ docker run --env-file .env -p 3000:3000 madgrades.com

Native instructions

Requirements

• Nodejs >= 10 (?)
• NPM
• Git

Steps

1. Install the required dependencies.

   $ npm install

2. Get a Madgrades API token from api.madgrades.com, or start up your own backend (see dockerfiles).
3. Create a .env file based on the provided .env.example.
4. Run the development server.

   $ npm start

Create a production-ready app with:

$ npm run build

Example Page

This is a course page: