Sean Blackburn
08f4c076d9
chore: Add a basic README
|
hai 1 ano | |
|---|---|---|
| public | hai 1 ano | |
| src | hai 1 ano | |
| .env.development | hai 1 ano | |
| .eslintrc.cjs | hai 1 ano | |
| .gitignore | hai 1 ano | |
| .pre-commit-config.yaml | hai 1 ano | |
| LICENSE.md | hai 1 ano | |
| README.md | hai 1 ano | |
| cspell.config.yaml | hai 1 ano | |
| eslint.config.js | hai 1 ano | |
| index.html | hai 1 ano | |
| makefile | hai 1 ano | |
| package-lock.json | hai 1 ano | |
| package.json | hai 1 ano | |
| postcss.config.cjs | hai 1 ano | |
| tailwind.config.cjs | hai 1 ano | |
| tsconfig.json | hai 1 ano | |
| tsconfig.node.json | hai 1 ano | |
| vite.config.ts | hai 1 ano |
README.md
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.
Local development
You need to have the following tools installed before starting:
-
git clone https://codeberg.org/Modulplaner/modulplaner.git npm install npm run dev