README.md

mme-sose24-statistics

Logo and title

Logo

Source: Logo is generated with Mircosoft Designer (https://designer.microsoft.com/image-creator)

Title

Usability Analyzer

About the app

This is a statistical tool for basic data analysis on usability data.

Features

• Import/export of CSV files.
• Interactive data creation and editing.
• Dynamically generated statistic diagrams.
• Supports for multiple types of usability questionnaires (UEQ, SUS, raw TLX, NPS).
• Detailed data report.
• Formula parsing and evaluation for data transformation.
• Human readable error messages.

Setup

To install the application, run

$ git clone https://github.com/UniRegensburg/mme-sose24-statistics.git
$ cd mme-sose24-statistics
$ npm install

To start the application, run

$ npm run dev

The application will then be running on http://localhost:5174/.

Usage

See tutorial. For video demonstration, see https://youtu.be/LOki-pQkASo.

Documentations

Developer guidelines

See GUIDELINES.md.

Architecture

• Main architecture: The main architecture contains 3 main parts.

  • Models: Consist of data structures called entities. Represent inner logics and provide developer-friendly interfaces.

  • Services: Stateless, globally accessible sets of utility functions.

  • Components: React components.

• Interaction between models and components: WorkspaceEntity provides the main entry point for React components. Services may act as intermediate in this interaction.

Tutorials for developers

Tutorial on Entities

Tutorial on Services

Technologies and libraries

• Vite
• Vitest
• React
• D3.js
• Observable Plot
• Material UI
• react-resizable-panels