ka-mensa-ui

Introduction

ka-mensa-ui is one component in a three-part project whose goal it is to aggregate, process and visualize the Studierendenwerk Karlsruhe's canteen plans in ways superior to the official sources.

Disclaimer: This project is neither affiliated with nor endorsed by the Studierendenwerk Karlsruhe or the Karlsruhe Institute of Technology.

The entire project is written in JavaScript+TypeScript and is composed as follows:

ka-mensa-fetch: library package responsible for the fetching of raw plan data and conversion into canonical, easily digestible JSON documents
ka-mensa-api: NodeJS server that utilizes the fetcher to continuously collect meal plans and makes them available via REST API
ka-mensa-ui: single-page web app that loads meal plans from an API instance and displays them in a modern, responsive interface with filtering and color-coding capabilities

Setup

Make sure to have a ka-mensa-api server running and publicly accessible. If on another domain, you have to configure your server to set CORS headers. Now you've got two choices: You can clone this repository via Git, build manually and use your own web server; or you can use a pre-built Docker image based on Nginx.

The Git Way

Clone this repository somewhere. Make sure Node and npm are installed on your system. Then run npm install. For configuration, see the .env file. Pay special attention to setting the API endpoint so that requests can be sent to your API server.

If you now run npm run build, the frontend will be compiled with the configured options and the result placed in the dist directory. Throw it on a webserver and you're good to go!

The Docker Way

This project on the Docker Hub: https://hub.docker.com/r/meyfa/ka-mensa-ui

To start a webserver linked to your API instance, simply run the Docker container and pass in config options via environment variables:

docker run \
        --name mensa-ui \
        -p <host-port>:80 \
        -e API_ENDPOINT=https://my-ka-mensa-api.example.com \
        -e PRIVACY_POLICY_URL=https://example.com/privacy \
        -d meyfa/ka-mensa-ui

It's as simple as that! Note that specifying API_ENDPOINT is mandatory. The environment variables MUST NOT contain single quotes, double quotes or backslashes, unless you want to figure out how to escape them properly.

(Internally, there is some magic that injects these environment variables into the nginx config, which then injects them into the page.)

Development

Contributions are welcome. Guidelines:

By contributing, you agree to make your changes available under the MIT license of this project.
Please write unit tests for as much code as possible.
- To run: npm test
Make sure to adhere to JS standard style and proper usage of TypeScript.
- Linter: npm run lint
- Automatic fixing of most style issues: npm run lint-fix

To make developing easier, a dev server with hot update capabilities can be started via npm run dev.