# Modulplaner

A simple frontend in Typescript/Vue to manage timetables for your next term at university.

## Features

- Planing of a term based on weekly lectures
- Planing of block Lectures
- Create multiple personal plans
- Share plans with others
- Save as a PDF
- Hide previously completed modules
- View the history of previous lectures for a module
- View dependencies to attend modules


## Customization

The `.env.development` file contains some default environment variables that may be
customized during the building process by including a `.env.production` file with custom
values.


## API Endpoints

All required API endpoints are are documented in the [OpenAPI documentation repo](https://codeberg.org/Modulplaner/openapi).


## Local development

You need to have the following tools installed before starting:

- [Node 20+](https://nodejs.org/)


```bash
git clone https://codeberg.org/Modulplaner/modulplaner.git
npm install
npm run dev
```