Teaching Dev

Diese Seite basiert auf Docusaurus, einem modernen statischen Website-Generator. Sie fügt viele hilfreiche Funktionalität für den Einsatz im Unterricht hinzu.

TDEV-Website

The tdev docs are located in the tdev-website folder. To start a local development server, run:

SITE_CONFIG_PATH="tdev-website/siteConfig.ts" yarn start

or add the SITE_CONFIG_PATH to your .env file.

ENV

Variable	For	Default	Example	Description
APP_URL	Production	http://localhost:3000		Domain of the hosted app
BACKEND_URL	Production	http://localhost:3002		Url of the API Endpoint
DEFAULT_TEST_USER	Development		admin.bar@bazz.ch	To log in offline. Email of the user to be selected by default. Must correspond to a user email found in the API's database.*
OFFLINE_API	Dev/Production	memory	true	memory
SENTRY_DSN	Production			Sentry DSN for error tracking
SENTRY_AUTH_TOKEN	Production			Sentry Auth Token for error tracking
SENTRY_ORG	Production			Sentry Org for error tracking
SENTRY_PROJECT	Production			Sentry Project for error tracking
GH_OAUTH_CLIENT_ID	Production			Client ID for the GitHub OAuth app used for CMS auth
SITE_CONFIG_PATH	Dev/Production	siteConfig.ts		Path to the site config file to be used.

* To change users, clear LocalStorage to delete the API key created upon first authentication.

Upgrade Docusaurus

To upgrade docusaurus, run:

yarn upgrade @docusaurus/core@latest @docusaurus/faster@latest @docusaurus/preset-classic@latest @docusaurus/theme-classic@latest @docusaurus/theme-common@latest @docusaurus/module-type-aliases@latest @docusaurus/plugin-rsdoctor@latest @docusaurus/tsconfig@latest @docusaurus/types@latest @docusaurus/theme-mermaid@latest

VS-Code Setup

• TODO-Tree: Install ripgrep (sudo apt-get install ripgrep) and specify the path (locate it with which rg, on ubuntu/wsl: "todo-tree.ripgrep.ripgrep": "/usr/bin/rg")

Upgrade tdev

After detatching a fork of teaching-dev, it will be necessary to periodically update the core framework.

To update to the lastest version of teaching-dev, run yarn updateTdev in the local repository (i.e. the detached fork). Afterwards, check the log for changes to non-tracked files and installable / upgradeable packages.

The update behavior can be customized by editing updateTdev.config.yaml. The following excerpt explains how the update behavior is configured:

tdevPath: ../teaching-dev # The path to the mainline teaching-dev repository.
expectedTdevBranch: main # The expected branch for the mainline teaching-dev repository. Change this only to update a pre-release or historic branch.
trackedElements: # The elements to be synchronized from the mainline teaching-dev repository to the local repository.
    - src: docusaurus.config.ts # Sync the mainline teaching-dev `docusaurus.config.ts` file...
      dst: docusaurus.config.ts # ...to `docusaurus.config.ts` in the custom repository.
    - src: src/ # Sync the mainline teaching-dev `src/` directory...
      dst: src # ...to `src` in the custom repository (Caution: this will override / delete custom files in the custom `src` repository!)
    # ...
watchedElements: # Log changes to these files (glob patterns) in the mainline teaching-dev repository without modifying local files.
    - .env.example
    # ...