Merge pull request #329 from ls1intum/code-cleanup

Implement Testing

.github/workflows/build_docker.yml

@@ -46,6 +46,27 @@ jobs:
         with:
           files: server/**
 
+      # Set up Java for server tests
+      - name: Set up JDK 21
+        if: ${{ steps.changed-files-server-folder.outputs.any_changed == 'true' && matrix.path == 'server' }}
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+          cache: 'gradle'
+
+      # Grant execute permission for gradlew
+      - name: Grant execute permission for gradlew
+        if: ${{ steps.changed-files-server-folder.outputs.any_changed == 'true' && matrix.path == 'server' }}
+        run: chmod +x ./server/gradlew
+
+      # Run tests for server
+      - name: Run server tests
+        if: ${{ steps.changed-files-server-folder.outputs.any_changed == 'true' && matrix.path == 'server' }}
+        working-directory: ./server
+        run: |
+          ./gradlew test
+
       - name: Log in to the Container registry
         if: ${{ (steps.changed-files-client-folder.outputs.any_changed == 'true') || (steps.changed-files-server-folder.outputs.any_changed == 'true') }}
         uses: docker/login-action@v3

README.md

@@ -1,10 +1,51 @@
 # ThesisTrack
 
-Web Application that represents the complete thesis lifecycle of theses applied for and supervised at the chair.
+ThesisTrack is a web-based thesis management system designed to streamline the thesis process in academic institutions by integrating essential stages into a single platform. 
+Developed to address challenges in managing large volumes of theses, it facilitates seamless interactions between students, advisors, and supervisors. 
+Key features include a centralized application process, guided workflows for thesis writing, automated notifications, and a comprehensive Gantt chart for tracking progress. 
+By consolidating communication, feedback, and file management, ThesisTrack enhances transparency, reduces administrative burdens, and fosters efficient thesis supervision and assessment.
 
-## Documentation
+ThesisTrack was developed as part of this [bachelor's thesis](docs/files/ba-thesis-fabian-emilius.pdf).
+
+## User Documentation
+
+#### Student
+- Submit Thesis Application
+- Edit Thesis Application
+- Upload Proposal
+- Upload Thesis Files
+- Create Presentation Draft
+- Manage User Settings
+
+#### Advisor
+- Create Thesis Topic
+- Review Applications
+- Review Proposal
+- Add Comments
+- Schedule Presentation
+- Submit Thesis Assessment
+
+#### Supervisor
+- Add Final Grade + Complete Thesis
+- Thesis Overview
+
+## Developer Documentation
 
 1. [Production Setup](docs/PRODUCTION.md)
 2. [Configuration](docs/CONFIGURATION.md)
 3. [Customizing E-Mails](docs/MAILS.md)
-4. [Development Setup](docs/DEVELOPMENT.md)
+4. [Development Setup](docs/DEVELOPMENT.md)
+5. [Database Changes](docs/DATABASE.md)
+
+## Features
+
+The following flowchart diagrams provide a visual overview of the thesis processes implemented in ThesisTrack. 
+These diagrams illustrate the step-by-step workflows involved, from thesis topic selection and application submission to the final grading and completion stages. 
+They highlight key actions, decision points, and interactions between students, advisors, and supervisors, clarifying how tasks are sequenced and managed within the system. 
+These flowcharts offer a quick reference for understanding how each role engages in the thesis process, ensuring transparency and consistency in task progression and responsibilities across different stages.
+
+#### Thesis Application Flowchart
+![Thesis Application Flowchart](docs/files/thesis-application-flowchart.svg)
+
+#### Thesis Writing Flowchart
+![Thesis Writing Flowchart](docs/files/thesis-writing-flowchart.svg)