Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dino-kupinic/untisplanner
✨ cross-platform and intuitive planner to complement Untis.
https://github.com/dino-kupinic/untisplanner
agile nuxt3 pwa school-assignment typescript vitest vue
Last synced: 4 days ago
JSON representation
✨ cross-platform and intuitive planner to complement Untis.
- Host: GitHub
- URL: https://github.com/dino-kupinic/untisplanner
- Owner: Dino-Kupinic
- License: gpl-3.0
- Created: 2023-12-04T07:48:52.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-03-25T14:11:43.000Z (8 months ago)
- Last Synced: 2024-03-25T16:08:49.093Z (8 months ago)
- Topics: agile, nuxt3, pwa, school-assignment, typescript, vitest, vue
- Language: Vue
- Homepage: https://untis-planner.vercel.app
- Size: 1.96 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://untis-planner.vercel.app/)
# UntisPlanner
UntisPlanner is an easy-to-use application for generating a special teaching plan which currently has to be done manually.
> [!CAUTION]
> UntisPlanner is still in Development. Until `v1.0.0` you will find bugs and broken/unfinished features.
## ✨ Installation and Configuration
### Installation for Development
1. clone the repository:
```bash
git clone https://github.com/Dino-Kupinic/UntisPlanner.git
```
2. install packages (```-f``` might be needed)
```bash
npm i
```
3. install playwright browsers for testing
```bash
npx playwright install
```
4. run dev server
```bash
npm run dev
```
5. Head to http://localhost:3001/
## 🚀 Deployment
1. run build
```bash
npm run build
```
2. check if everything works as it should
```bash
npm run preview
```
3. Head to http://localhost:3000/
4. All generated assets can be found in `./output`
> [!TIP]
> Further information regarding deployment can be found on https://nuxt.com/deploy
## 🌍 Live Demo
A live demo of UntisPlanner is available on https://untis-planner.vercel.app/
> [!IMPORTANT]
> The live demo is based on the `main` branch. If you want to test the latest features, you should head to the `develop` branch.
# Features
### Generation Options
- Federal State selection (Upper Austria, Salzburg, Vienna, ...)
- Period
- Lesson Days (Monday - Friday)
- Teacher selection
- Year
### Legend
- Quick reference for which colors represents which mark in the Calendar
### Calendar
- Year view with color marked holidays and teaching periods
- Left/Right arrows for navigating calendar
- Quick travel by clicking on a month
- Popover for detailed information on each marking
### Export
- Table display of generation result
- Option for downloading or copying to clipboard
- JSON/CSV format support
### Settings
- Language selection
- Theme selection
- Creating/Removing teachers
- Creating/Removing custom holidays
### Other
- Light/Dark Mode
## 😄 Authors
- [@Dino Kupinic](https://www.github.com/Dino-Kupinic)
- [@Michael Ploier](https://www.github.com/MPloier)
- [@Jannick Angerer](https://www.github.com/Neuery17Alt)
- [@Daniel Samhaber](https://www.github.com/dsamhabe)
## 🛠️ Tech Stack
**Client:**
- Nuxt 3 with TypeScript
**Libraries:**
- NuxtUI
- VueUse
- Pinia
- date-holidays
- PWA
- VCalendar
- Vitest
- Playwright
You can find all dependencies in the `package.json` and for the `nuxt.config.ts` in the `modules` section.
## 🦋 License
[GNU](https://choosealicense.com/licenses/gpl-3.0/)