/maria

A library to simplify fetching from the "Schulportal Hessen"

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0





Designed to simplify.

🎒 About Maria

A library to fetch from the Schulportal, a website used by students and teachers in Hessen, Germany.

🚀 Quick Start

npm i maria-hessen

📚 Features

  • Handle authentication / Session Management
  • Fetch representative teacher plan
  • Fetch homework on the "Mein Unterricht" (My Lessons) page"

🛠️ Usage

  1. Get your school's name and city from the login page.

Tip

Look up how the Schulportal knows your school. Sometimes the names are weird and contain locations.

const maria = new Maria({
    auth: {
        username: "max.mustermann",
        password: "secure-password",
        school: {
            name: "Mosaikschule",
            city: "Frankfurt a. M.",
        },
    },
});

const currentRepPlan = await maria.fetchRepPlan({});

const futureRepPlan = await maria.fetchRepPlan({
    date: new Date("18 Sep 2024"),
});

Important

This library is not officially affiliated with the "Schulportal Hessen" or "Lanis" website. It is a community-driven project created by students in their free time.