Talk 2022-10-28 - Musiktheorie Symposium

project overview

This project contains the slides for my talk on 2022-10-28 at the Musiktheorie Symposium* about FMADB.
The presented language is German, the repository and documentation language is English.

*https://www.hfmdd.de/hochschule/institute-einrichtungen/zentrum-fuer-musiktheorie

development

system requirement

• development VM ID from Thorsten Seyschab for this project: 0Z1
• OS:
  • Ubuntu (recommended)
  • Windows: install Ubuntu Subsystem as WSL2 (not WSL1) and use the Ubuntu Shell/ Terminal for everything (not CMD or Git BashShell)
• IDE:
  • VSCode (Visual Studio Code) (recommended)
    The project already has all configuration files for this IDE. Especially the ./.vscode/extensions.json tell you the recommended plugins to use.
• Testing:
  • Currently not needed.

initial setup

system requirements for developing

The following software is needed for developing:
The versions are what I used for development and testing. I will update the list if something changes.

software	command for version output	my version at last use	information
Ubuntu	lsb_release -a or cat /etc/os-release	v22.04.1 LTS
nvm	nvm -v	v0.39.1
Node	node -v (old nodejs --version)	v16.17.1	NodeJS/ Node.js
npm	npm -v	v8.15.0
npx	npx -v	v8.15.0
pnpm	pnpm -v	v7.14.0	used as package manager

project setup

1. execute a git pull
2. open project in VSCode
3. If you work with VSCode via remote software:
   {Ctrl}+{Shift}+{P} -> >Preferences: Open Settings (UI) -> search for keyboard.dispatch and set it to keyCode
   Restart or reload VSCode.
4. execute the following commands in order to set up the project:

# install dependencies
pnpm install

scripts / commands

# dev run
pnpm run dev
# you get:
# - public slide show   > http://localhost:3030/
# - presenter mode      > http://localhost:3030/presenter/

# dev run
pnpm run devRemote
# like the normal `dev` command, but ports are open to full local network.

# build
pnpm run build

# export
pnpm run export

prisma schema to UML

Uses https://github.com/emyann/prisma-uml to convert the FMADB prisma schema to a UML diagram.

FMADB

//TODO add short project description here

Head of project https://fmadb.org, which is part of the talk:

• Thorsten Seyschab is responsible for the development of FMADB which includes the creation of the data models, the programming of all parts, the deployment and the maintenance.
• Susanne Hardt is responsible for the music theoretical background of FMADB and helped developing the meta data model for the music analytical parameters and their evaluations in the software.

Attribution

Head of this project:

• Thorsten Seyschab created the slides and held the talk.

Honorable mentions:

• Susanne Hardt helped me with the music theoretical background.

Used services and dependencies:

• Slidev used for creating the slides of the talk, with:
  • documentation
  • themes

License

This project is under the CC-BY-NC-ND-4.0 license. See LICENSE file for more information.

Copyright (c) 2022-present, Thorsten Seyschab.