chore: update README with updated links und up to date documentation (#…

…3884) Co-authored-by: Roland Schläfli <rolandschlaefli@gmail.com>
uzh-bf · Oct 1, 2023 · 45f6e7d · 45f6e7d
1 parent 93646ea
commit 45f6e7d
Show file tree

Hide file tree

Showing 19 changed files with 69 additions and 78 deletions.
diff --git a/README.md b/README.md
@@ -1,54 +1,61 @@
 <img src="https://manage.klicker.uzh.ch/KlickerLogo.png" width="350">
 
-> Please note that this is the repository branch for the upcoming KlickerUZH v3.0 with a beta launch scheduled before the spring semester 2023 and stable release for the autumn semester 2023. If you would like to have more information on the new concept of v3.0, have a look at our [public discussion](https://community.klicker.uzh.ch/t/klickeruzh-v3-0-concept-and-request-for-feedback/79).
+> Please note that this is the repository branch for KlickerUZH v3.0 released in August 2023. If you would like to have more information on the new concept of v3.0, have a look at our [public discussion](https://community.klicker.uzh.ch/t/klickeruzh-v3-0-concept-and-request-for-feedback/79).
 >
-> Please navigate to the [dev branch](https://github.com/uzh-bf/klicker-uzh/tree/dev) for the currently stable production code.
+> Please navigate to the [dev branch](https://github.com/uzh-bf/klicker-uzh/tree/dev) for the older [KlickerUZH v2.0](https://app.klicker.uzh.ch/), which will be available until the end of 2023. To migrate to KlickerUZH v3.0, start the [migration process](https://manage.klicker.uzh.ch/migration).
 
 `klicker-uzh` is the code repository of the [KlickerUZH](https://www.klicker.uzh.ch/) open-source audience interaction platform. KlickerUZH is developed by the Teaching Center of the Department of Banking and Finance at the University of Zurich, Switzerland.
 
-![Klicker Screenshot Timeline](https://www.klicker.uzh.ch/img/timeline_mac.png)
+![Klicker Screenshot Timeline](apps/docs/static/img/question_pool_mac.png)
 
-KlickerUZH v3.0 uses multiple different services that communicate with each other:
+KlickerUZH v3.0 uses multiple different web applications and services, which communicate with each other:
 
-- [Frontend PWA](https://github.com/uzh-bf/klicker-uzh/tree/v2/apps/frontend-pwa) is the student frontend of KlickerUZH, which contains the student views for live sessions, micro-learnings, repetition elements, leaderboards and more.
-- [Frontend Manage](https://github.com/uzh-bf/klicker-uzh/tree/v2/apps/frontend-manage) is the lecturer frontend of KlickerUZH, which provides all the functionalities that lecturers need, including but not limited to question management, session management, course management and analytics.
-- [Backend Docker](https://github.com/uzh-bf/klicker-uzh/tree/v2/apps/backend-docker) is the main backend service of KlickerUZH.
-- [Backend Responses](https://github.com/uzh-bf/klicker-uzh/tree/v2/apps/backend-responses) is a service that handles incoming student responses during a live session and puts them into an Azure queue for load handling reasons.
-- [Backend Response Processor](https://github.com/uzh-bf/klicker-uzh/tree/v2/apps/backend-response-processor) accesses queued elements from the aforementioned service and processes them by computing scores, updating the cache, etc.
+- [Frontend PWA](https://github.com/uzh-bf/klicker-uzh/tree/v3/apps/frontend-pwa) is the student frontend of KlickerUZH, which contains the student views for live quizzes, microlearnings, practice quizzes, leaderboards and more.
+- [Frontend Manage](https://github.com/uzh-bf/klicker-uzh/tree/v3/apps/frontend-manage) is the lecturer frontend of KlickerUZH, which provides all the functionalities that lecturers need, including but not limited to question management, session management, course management and analytics.
+- [Fontend Control](https://github.com/uzh-bf/klicker-uzh/tree/v3/apps/frontend-control) is a minimal controller frontend, which allows to control live sessions from mobile devices in an optimized layout. Soon, this app will also be available as a [PowerPoint integration](https://github.com/uzh-bf/klicker-uzh/tree/v3/apps/office-addin) (work in progress) for catalyst users.
+- [Fontend Authentication](https://github.com/uzh-bf/klicker-uzh/tree/v3/apps/auth) is the authentication frontend of KlickerUZH, providing login functionalities through Edu-ID accounts and delegated logins to the manage frontend.
+- [Backend Docker](https://github.com/uzh-bf/klicker-uzh/tree/v3/apps/backend-docker) is the main backend service of KlickerUZH.
+- [Backend Responses](https://github.com/uzh-bf/klicker-uzh/tree/v3/apps/func-incoming-responses) is a service that handles incoming student responses during a live session and puts them into an Azure queue for improved load handling.
+- [Backend Response Processor](https://github.com/uzh-bf/klicker-uzh/tree/v3/apps/func-response-processor) accesses queued elements from the aforementioned service and processes them by computing scores and experience points, updating the cache, etc.
+- The [v2.0 Export](https://github.com/uzh-bf/klicker-uzh/tree/v3/apps/func-migration-v2-export) and [v3.0 Import](https://github.com/uzh-bf/klicker-uzh/tree/v3/apps/func-migration-v3-import) folders contain serverless Azure Functions related to the migration from KlickerUZH v2.0 to v3.0.
 
-In addition to key application components, this repository also includes the codebases for our landing page and documentation (www.klicker.uzh.ch), as well as deployment scripts and examples:
+In addition to the key application components, this repository also includes the codebases for our landing page and documentation at [www.klicker.uzh.ch](https://www.klicker.uzh.ch/), as well as deployment scripts for Helm/Kubernetes. An updated deployment documentation for self-hosting KlickerUZH v3.0 will be added until the end of the year.
 
-- [Legacy Docs and Websites](https://github.com/uzh-bf/klicker-uzh/tree/v2/docs) (subfolder)
-- [Deployment](https://github.com/uzh-bf/klicker-uzh/tree/v2/deploy) (subfolder)
+- [Documentation and Website](https://github.com/uzh-bf/klicker-uzh/tree/v3/apps/docs) (subfolder)
+- [Deployment](https://github.com/uzh-bf/klicker-uzh/tree/v3/deploy) (subfolder)
 
-To share code more easily between different services, we added new packages to the [Package Directory](https://github.com/uzh-bf/klicker-uzh/tree/v2/packages) with the following components:
+To share code more easily between different services, we added new packages to the [Package Directory](https://github.com/uzh-bf/klicker-uzh/tree/v3/packages) with the following components:
 
-- [Grading](https://github.com/uzh-bf/klicker-uzh/tree/v2/packages/grading): The grading package provides the grading logic that is used to assign scores to participants and groups in live sessions, learning elements, micro-sessions and other KlickerUZH elements.
-- [Markdown](https://github.com/uzh-bf/klicker-uzh/tree/v2/packages/markdown): The markdown package exports a React component to render markdown strings into formatted elements.
-- [Shared Components](https://github.com/uzh-bf/klicker-uzh/tree/v2/packages/shared-components): The `shared-components` package is configured as an internal turborepo package, mainly providing the possibility to share components between the two frontends and reduce code duplication.
+- [Prisma](https://github.com/uzh-bf/klicker-uzh/tree/v3/packages/prisma): The prisma package contains the SQL database schema as well as migration scripts between different minor versions of KlickerUZH.
+- [GraphQL](https://github.com/uzh-bf/klicker-uzh/tree/v3/packages/graphql): The GraphQL package contains the complete GraphQL schema and all resolvers for the KlickerUZH backend, as well as all business logic for provided services. For consistent typing, Pothos GraphQL and an auto-generated schema are used.
+- [Grading](https://github.com/uzh-bf/klicker-uzh/tree/v3/packages/grading): The grading package provides the grading logic that is used to assign scores and experience points to participants and groups in gamified live sessions, learning elements, micro-sessions and other KlickerUZH elements.
+- [LTI](https://github.com/uzh-bf/klicker-uzh/tree/v3/packages/lti): The LTI package contains logic to offer automatic sign ins for students through the Learning Tools Interoperability "LTI" standard (for OpenOLAT and Moodle integration).
+- [Internationalization](https://github.com/uzh-bf/klicker-uzh/tree/v3/packages/i18n): The i18n package provides internationalized messages for all KlickerUZH services.
+- [Shared Components](https://github.com/uzh-bf/klicker-uzh/tree/v3/packages/shared-components): The `shared-components` package is configured as an internal turborepo package, mainly providing the possibility to share React components between the frontends and reduce code duplication.
+- [Markdown](https://github.com/uzh-bf/klicker-uzh/tree/v3/packages/markdown): The markdown package exports a React component to render markdown strings into formatted elements.
 
-For more code commonality between different projects at the Teaching Center and the Department of Banking and Finance more generally, we also introduced a [Design System Package](https://github.com/uzh-bf/design-system) with commonly used components.
+For more code commonality between different projects at the Teaching Center and the Department of Banking and Finance more generally, we also use a [Design System Package](https://github.com/uzh-bf/design-system) with commonly used, pre-styled and theme-based components.
 
 ## 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](https://www.klicker.uzh.ch/development). Please feel free to add any issues or feature requests you might have to the [Roadmap](https://klicker-uzh.feedbear.com) or start a new discussion in our [Community](https://community.klicker.uzh.ch/).
+The KlickerUZH project is publicly managed and documented in this repository. A corresponding roadmap of our current developments can be found on our [Homepage](https://www.klicker.uzh.ch/development). Please feel free to add any issues or feature requests you might have to the [Roadmap](https://klicker-uzh.feedbear.com) and [Bug reports](https://klicker-uzh.feedbear.com/boards/bug-reports) or start a new discussion in our [Community](https://community.klicker.uzh.ch/).
 
-## Further Resources
+## Important Links
 
-The following additional resources might be of interest to you:
+The following resources might be of special interest to you:
 
-- [Documentation](https://www.klicker.uzh.ch/introduction/getting_started)
+- [User Documentation](https://www.klicker.uzh.ch/getting_started/welcome)
 - [Frequently Asked Questions](https://www.klicker.uzh.ch/faq)
-- [Community and Discussions](https://www.klicker.uzh.ch/community)
+- [Community and Discussions](https://community.klicker.uzh.ch/)
 - [Roadmap](https://klicker-uzh.feedbear.com)
 
 ## Deployment
 
-This section is still work in progress as our architecture continues to experience minor changes. If you would like to deploy an instance of the currently stable version of KlickerUZH, please refer to the corresponding [Deployment Section](https://www.klicker.uzh.ch/deployment/deployment_architecture) of the legacy docs.
+This section is still work in progress as our architecture continues to experience minor changes and will be updated as soon as possible. If you would like to deploy an instance of the legacy KlickerUZH v2.0, please refer to the corresponding [Deployment Section](https://www.klicker.uzh.ch/v2/deployment/deployment_docker/) of the legacy docs.
 
 ## 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](https://www.klicker.uzh.ch/contributing/contributing_guidelines), as your PR might need amendments otherwise.
+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](https://www.klicker.uzh.ch/v2/contributing/contributing_guidelines/), as your PR might need amendments otherwise.
 
 ## License
 

diff --git a/apps/auth/package.json b/apps/auth/package.json
@@ -8,7 +8,7 @@
     "@klicker-uzh/prisma": "workspace:*",
     "@klicker-uzh/shared-components": "workspace:*",
     "@next-auth/prisma-adapter": "1.0.7",
-    "@uzh-bf/design-system": "2.1.7",
+    "@uzh-bf/design-system": "2.1.8",
     "axios": "1.4.0",
     "bcryptjs": "2.4.3",
     "js-cookie": "3.0.5",

diff --git a/apps/backend-docker/package.json b/apps/backend-docker/package.json
@@ -45,7 +45,7 @@
     "@types/node": "^18.17.4",
     "@types/passport": "^1.0.10",
     "@types/passport-jwt": "^3.0.6",
-    "@uzh-bf/design-system": "2.1.7",
+    "@uzh-bf/design-system": "2.1.8",
     "axios": "1.4.0",
     "cross-env": "7.0.3",
     "dotenv": "16.0.3",

diff --git a/apps/docs/package.json b/apps/docs/package.json
@@ -20,7 +20,7 @@
     "@gabrielcsapo/docusaurus-plugin-matomo": "0.1.2",
     "@mdx-js/react": "2.3.0",
     "@tsconfig/docusaurus": "1.0.5",
-    "@uzh-bf/design-system": "2.1.7",
+    "@uzh-bf/design-system": "2.1.8",
     "autoprefixer": "10.4.14",
     "cross-env": "7.0.3",
     "nodemon": "3.0.1",

diff --git a/apps/docs/static/img/question_pool_mac.png b/apps/docs/static/img/question_pool_mac.png
diff --git a/apps/frontend-control/README.md b/apps/frontend-control/README.md
diff --git a/apps/frontend-control/package.json b/apps/frontend-control/package.json
@@ -17,7 +17,7 @@
     "@klicker-uzh/shared-components": "workspace:*",
     "@sentry/nextjs": "7.61.1",
     "@socialgouv/matomo-next": "1.6.1",
-    "@uzh-bf/design-system": "2.1.7",
+    "@uzh-bf/design-system": "2.1.8",
     "body-parser": "1.20.2",
     "cross-env": "7.0.3",
     "dayjs": "1.11.9",

diff --git a/apps/frontend-manage/README.md b/apps/frontend-manage/README.md
diff --git a/apps/frontend-manage/package.json b/apps/frontend-manage/package.json
@@ -17,7 +17,7 @@
     "@klicker-uzh/prisma": "workspace:*",
     "@klicker-uzh/shared-components": "workspace:*",
     "@socialgouv/matomo-next": "1.6.1",
-    "@uzh-bf/design-system": "2.1.7",
+    "@uzh-bf/design-system": "2.1.8",
     "d3": "7.8.4",
     "dayjs": "1.11.9",
     "deepmerge": "4.3.1",

diff --git a/apps/frontend-pwa/README.md b/apps/frontend-pwa/README.md
diff --git a/apps/frontend-pwa/package.json b/apps/frontend-pwa/package.json
@@ -22,7 +22,7 @@
     "@klicker-uzh/shared-components": "workspace:*",
     "@radix-ui/react-tabs": "1.0.3",
     "@socialgouv/matomo-next": "1.6.1",
-    "@uzh-bf/design-system": "2.1.7",
+    "@uzh-bf/design-system": "2.1.8",
     "body-parser": "1.20.2",
     "dayjs": "1.11.9",
     "deepmerge": "4.3.1",

diff --git a/apps/func-incoming-responses/package.json b/apps/func-incoming-responses/package.json
@@ -18,7 +18,7 @@
     "@tsconfig/recommended": "^1.0.2",
     "@types/jsonwebtoken": "^9.0.2",
     "@types/node": "^18.17.4",
-    "@uzh-bf/design-system": "2.1.7",
+    "@uzh-bf/design-system": "2.1.8",
     "azure-functions-core-tools": "4.0.5390",
     "cross-env": "7.0.3",
     "dotenv": "16.0.3",

diff --git a/apps/func-response-processor/package.json b/apps/func-response-processor/package.json
@@ -23,7 +23,7 @@
     "@types/md5": "2.3.2",
     "@types/node": "^18.17.4",
     "@types/ramda": "^0.29.3",
-    "@uzh-bf/design-system": "2.1.7",
+    "@uzh-bf/design-system": "2.1.8",
     "azure-functions-core-tools": "4.0.5390",
     "cross-env": "7.0.3",
     "dotenv": "16.0.3",

diff --git a/apps/office-addin/package.json b/apps/office-addin/package.json
@@ -4,7 +4,7 @@
   "license": "AGPL-3.0",
   "dependencies": {
     "@fluentui/react": "8.109.5",
-    "@uzh-bf/design-system": "2.1.7",
+    "@uzh-bf/design-system": "2.1.8",
     "core-js": "3.30.2",
     "es6-promise": "4.2.8",
     "formik": "2.4.3",

diff --git a/packages/lti/package.json b/packages/lti/package.json
@@ -24,7 +24,7 @@
     "typescript": "5.0.4"
   },
   "peerDependencies": {
-    "@uzh-bf/design-system": "2.1.7",
+    "@uzh-bf/design-system": "2.1.8",
     "next": "13.4.19",
     "react": "18.2.0",
     "react-dom": "18.2.0"

diff --git a/packages/markdown/package.json b/packages/markdown/package.json
@@ -44,7 +44,7 @@
     "@fortawesome/free-regular-svg-icons": "6.4.2",
     "@fortawesome/free-solid-svg-icons": "6.4.2",
     "@fortawesome/react-fontawesome": "0.2.0",
-    "@uzh-bf/design-system": "2.1.7",
+    "@uzh-bf/design-system": "2.1.8",
     "next": "13.4.19",
     "react": "18.2.0",
     "react-dom": "18.2.0",

diff --git a/packages/prisma/src/data/README.md b/packages/prisma/src/data/README.md
diff --git a/packages/shared-components/package.json b/packages/shared-components/package.json
@@ -30,7 +30,7 @@
     "@fortawesome/free-regular-svg-icons": "6.4.2",
     "@fortawesome/free-solid-svg-icons": "6.4.2",
     "@fortawesome/react-fontawesome": "0.2.0",
-    "@uzh-bf/design-system": "2.1.7",
+    "@uzh-bf/design-system": "2.1.8",
     "formik": "2.4.3",
     "next": "13.4.19",
     "next-intl": "2.19.1",