LockBlock-dev/iut-rcc-grades-tracker

Grades tracker for the IUT RCC university website

IUT RCC Grades Tracker

A tool to automatically fetch your grades from the IUT RCC university portal and send a detailed summary to your Discord.

The tracker periodically retrieves your new grades and delivers them in an easy-to-read Discord embed format, keeping you informed of your academic progress.

Table of Contents

• Installation
• Configuration
• Usage
• Docker
• Copyright

Installation

You can use Docker or install this app manually. Here's how:

1. Install Node.js.
2. Download or clone the project.
3. Navigate to the project directory.
4. Install the dependencies:

   npm install

5. Build the project:

   npm run build

Configuration

The configuration details must be set inside a .env file at the root of the project. An exemple is provided inside .env.example.

Usage

To start the application, run:

npm start

Docker

Alternatively, you can use Docker to set up and run the project:

1. Build the Docker image:

   docker build -t iut-rcc-grades-tracker .

2. Run the Docker container:

   docker run --env-file .env iut-rcc-grades-tracker

Copyright

See the license.