Sean Blackburn
a654db9893
chore: Add a small readme
|
hace 10 meses | |
|---|---|---|
| .vscode | hace 1 año | |
| img | hace 10 meses | |
| public | hace 1 año | |
| src | hace 10 meses | |
| .dockerignore | hace 10 meses | |
| .env.development | hace 1 año | |
| .gitignore | hace 1 año | |
| .pre-commit-config.yaml | hace 10 meses | |
| Dockerfile | hace 10 meses | |
| LICENSE.md | hace 1 año | |
| README.md | hace 10 meses | |
| compose.yaml | hace 10 meses | |
| cspell.config.yaml | hace 10 meses | |
| eslint.config.js | hace 10 meses | |
| index.html | hace 1 año | |
| makefile | hace 1 año | |
| package-lock.json | hace 10 meses | |
| package.json | hace 10 meses | |
| tailwind.config.cjs | hace 1 año | |
| tsconfig.json | hace 1 año | |
| tsconfig.node.json | hace 1 año | |
| vite.config.ts | hace 10 meses |
README.md
Modulplaner
A module planer web UI.
Made out of the frustration from using a 120 page long PDF to plan my next semester. Easily find your modules and when they take place, add them to your plan and share it with your colleagues.
This repo only contains the frontend code. The data behind the modules must be provided by you. This is meant to be hosted inside of a webserver like nginx.
Features
- Create one or more plans per semester
- Share your plan by:
- Sharing a link
- Printing it
- Filter by
- Module
- Building
- Time / weekday
- Room
- ...
- Module dependencies
- On site / hybrid / online only
- See past lectures for a module
- ...
Development
Docker
docker compose build
# OR
docker build -t modulplaner-ui .
[!NOTE]
Currently the
.envhas to be injected during the build phase. Otherwise, certain texts / links will not work or be displayed.
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.