Skip to content

Documentation Improvements #756

@4ydan

Description

@4ydan

Thank you for this excellent thesis management system!

After a test deployment, I found these documentation gaps:

1. Missing group-admin Role in Keycloak Template

keycloak_config.json is missing the group-admin client role → creating research groups fails.

Fix: Add group-admin role to template or document manual creation.

2. Email Required for Users

Application crashes with 500 if Keycloak users lack email addresses. Please add to DEVELOPMENT.md.

3 Research Group Assignment

Users get "must be assigned to a research group" 500 error, when they are supervisors but not in a research group (because they were given the role manually in Keycloak for example


Minor item:

  • Explain somewhere briefly the two Keycloak clients architecture, which one does what and maybe a full guide how to setup the realm without importing the json (the DEVELOPMENT.md doc is lacking some critical information).
  • Getting a quick test environment running required piecing together information from multiple files, could be put all into one compose to quickstart the app. Also a minimal example without keycloak auth just backend + frontend would be really amazing, but I can understand this is quite some effort.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions