diff --git a/README.md b/README.md index 9ee6984..e8034f7 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,30 @@ -# Calendar-Proxy +# TUM Calendar Proxy +![Alt text](image.png) -Proxy for the TUM iCal export to remove clutter from it and optimize the output +This is a proxy service that simplifies and enhances the iCal export from TUM Online. It allows you to: -You can find more information on the about page: https://cal.tum.sexy/ +- Shorten long lesson names, such as 'Grundlagen Betriebssysteme und Systemsoftware' → 'GBS' +- Add locations that are recognized by Google / Apple Maps +- Filter out unwanted events, such as cancelled, duplicate or optional ones + +You can use the proxy service by visiting and following the instructions there. ## Development -To run locally: - - run `go run cmd/proxy/proxy.go` to install dependencies and run a local server for testing on port 8081 +If you want to run the proxy service locally or contribute to the project, you will need: + +- Go 1.19 or higher +- Docker (optional) + +To run the service locally, follow these steps: + +- Clone this repository: `git clone https://github.com/tum-calendar-proxy/tum-calendar-proxy.git` +- Navigate to the project directory: `cd tum-calendar-proxy` +- Run the proxy server: `go run cmd/proxy/proxy.go` +- The service will be available at + +To build a production image using Docker, follow these steps: -To build a production image: -- run `docker build -t tumcalproxy .` -- run `docker run -p 8081:8081 tumcalproxy` -- open http://127.0.0.1:8081 in your browser +- Build the image: `docker build -t tumcalproxy .` +- Run the container: `docker run -p 8081:8081 tumcalproxy` +- The service will be available at diff --git a/image.png b/image.png new file mode 100644 index 0000000..168ff1b Binary files /dev/null and b/image.png differ