Home

Welcome to the Kwiz wiki!

This wiki describes the project (Kwiz) that we (Alex Scheitlin, Roland Schläfli, and Nik Zaugg) have worked on as part of our course on Advanced Software Engineering at the University of Zurich.

The following provides a short overview of our documentation structure:

Project Overview

Introduces our project and the datasets we have used to develop it, as well as the issues we still have on our roadmap.

Architecture

Describes the architecture of our microservice application and how we integrate everything into a single service.

Development

Introduces and motivates the development and devops practices (as taught in the course) that we have applied to our project by means of automated systems, tooling, and workflows.

API Reference

Provides an overview of all the APIs that we have developed for the purposes of our application.

Contribution Guidelines

Introduces the guidelines that we have developed and tried to follow while collaborating on the Kwiz project. These are also the guidelines that we would suggest any further contributors follow, if this were an active open source project.

Further Resources

Lists some important auxiliary resources (e.g., the course website).