|
|
@@ -1,7 +1,50 @@
|
|
|
# Modulplaner
|
|
|
|
|
|
-## Customization
|
|
|
+A module planer web UI.
|
|
|
|
|
|
-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.
|
|
|
+
|
|
|
+
|
|
|
+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
|
|
|
+
|
|
|
+```bash
|
|
|
+docker compose build
|
|
|
+# OR
|
|
|
+docker build -t modulplaner-ui .
|
|
|
+```
|
|
|
+
|
|
|
+> [!NOTE]
|
|
|
+>
|
|
|
+> Currently the `.env` has 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.
|
Sean Blackburn
