klicker-uzh
is the code repository of the KlickerUZH instant-class-response system. KlickerUZH is developed by the Teaching Center of the Department of Banking and Finance at the University of Zurich, Switzerland.
The KlickerUZH consists of two main services (see Architecture), as well as an additional Shibboleth service for integration with SwitchAAI:
- Frontend (subfolder)
- Backend (subfolder)
- Shibboleth (subfolder)
In addition to key application components, this repository also includes the codebases for our landing page (www.klicker.uzh.ch) and documentation (www.klicker.uzh.ch/docs), as well as deployment scripts and examples:
- Docs (subfolder)
- Deployment (subfolder)
Roadmap / Issues
The KlickerUZH project is publicly managed and documented in this repository. A corresponding roadmap of our current developments can be found on our Homepage. Please feel free to add any issues or feature requests you might have to the Roadmap, or start a new discussion on Github Discussions.
Further Resources
The following additional resources might be of interest to you:
Deployment
If you would like to deploy an instance of the KlickerUZH at your institution, please have a look at the corresponding documentation with regards to the Architecture, Requirements, and further Instructions.
We also provide a set of examples and resources for Docker-based deployments. The deploy
directory contains examples for Docker Compose deployments, as well as a Helm chart for a Kubernetes deployment (recommended for production).
Contributing
We welcome any contributions to the KlickerUZH project. Before considering any contribution, we recommend that you create a discussion to discuss your proposed addition with the project maintainers and other contributors. Please also make sure to follow our Contributing Guidelines, as your PR might need amendments otherwise.
License
The KlickerUZH and all of its subprojects are licensed under the AGPLv3.