Skip to content

Commit

Permalink
Update about page
Browse files Browse the repository at this point in the history
  • Loading branch information
fabian-emilius committed Nov 26, 2024
1 parent b601d51 commit c98295e
Show file tree
Hide file tree
Showing 7 changed files with 70 additions and 13 deletions.
17 changes: 14 additions & 3 deletions .github/workflows/deploy_docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,18 @@ jobs:
script: |
docker compose -f docker-compose.prod.yml --env-file=.env.prod down --remove-orphans --rmi all
- name: checkout
- name: Checkout Code
uses: actions/checkout@v4

- name: 'Create main.cf and master.cf file'
- name: Get Git Commit Hash
id: git_info
run: echo "GIT_COMMIT=$(git rev-parse HEAD)" >> $GITHUB_ENV

- name: Get Branch Name
id: branch_name
run: echo "GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD)" >> $GITHUB_ENV

- name: Create main.cf and master.cf File
run: |
echo "${{ vars.POSTFIX_MAIN_CF }}" > main.cf
echo "${{ vars.POSTFIX_MASTER_CF }}" > master.cf
Expand Down Expand Up @@ -80,7 +88,7 @@ jobs:
source: "master.cf"
target: /home/${{ vars.VM_USERNAME }}/postfix-config/

- name: SSH to VM and create .env.prod
- name: SSH to VM and Create .env.prod
uses: appleboy/[email protected]
with:
host: ${{ vars.VM_HOST }}
Expand Down Expand Up @@ -138,6 +146,9 @@ jobs:
echo "SERVER_IMAGE_TAG=${{ inputs.server_image_tag }}" >> .env.prod
echo "CLIENT_IMAGE_TAG=${{ inputs.client_image_tag }}" >> .env.prod
echo "GIT_COMMIT=${{ env.GIT_COMMIT }}" >> .env.prod
echo "GIT_BRANCH=${{ env.GIT_BRANCH }}" >> .env.prod
- name: SSH to VM and Execute Docker-Compose Up
uses: appleboy/[email protected]
Expand Down
2 changes: 2 additions & 0 deletions client/public/generate-runtime-env.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ const ALLOWED_ENVIRONMENT_VARIABLES = [
'CHAIR_URL',
'PRIVACY',
'IMPRINT',
'GIT_COMMIT',
'GIT_BRANCH',
// environments with defaults
'ALLOW_SUGGESTED_TOPICS',
'DEFAULT_SUPERVISOR_UUID',
Expand Down
5 changes: 5 additions & 0 deletions client/src/config/global.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ export const GLOBAL_CONFIG: IGlobalConfig = {

allow_suggested_topics: (getEnvironmentVariable('ALLOW_SUGGESTED_TOPICS') || 'true') === 'true',

git: {
commit: getEnvironmentVariable('GIT_COMMIT') || 'unknown',
branch: getEnvironmentVariable('GIT_BRANCH') || 'unknown'
},

genders: getEnvironmentVariable<Record<string, string>>('GENDERS', true) || {
MALE: 'Male',
FEMALE: 'Female',
Expand Down
5 changes: 5 additions & 0 deletions client/src/config/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ export interface IGlobalConfig {
study_degrees: Record<string, string>
languages: Record<string, string>

git: {
commit: string
branch: string
}

thesis_types: Record<
string,
{
Expand Down
48 changes: 40 additions & 8 deletions client/src/pages/AboutPage/AboutPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { Anchor, Center, Image, List, Stack, Text, Title } from '@mantine/core'
import flowchart from './flowchart.svg'
import { usePageTitle } from '../../hooks/theme'
import PublicArea from '../../app/layout/PublicArea/PublicArea'
import { GLOBAL_CONFIG } from '../../config/global'

const AboutPage = () => {
usePageTitle('About')
Expand All @@ -11,15 +12,37 @@ const AboutPage = () => {
<Stack>
<Title>ThesisTrack</Title>
<Text>
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.
ThesisTrack addresses inefficient manual thesis management processes at large universities
through a web-based platform. The system digitizes the entire lifecycle from student
applications to final grading, serving three key stakeholders: supervisors (professors),
advisors (doctoral candidates), and students. Key features include:
</Text>
<List>
<List.Item>
A structured application system allowing students to apply directly for specific thesis
topics
</List.Item>
<List.Item>
Centralized document management for proposals, theses, and presentations
</List.Item>
<List.Item>Built-in feedback mechanisms for proposal and thesis review</List.Item>
<List.Item>
A Gantt chart overview showing timelines and progress across multiple theses
</List.Item>
<List.Item>
Role-based access control with specific permissions for students, advisors, and
supervisors
</List.Item>
<List.Item>Automated notifications for important milestones and updates</List.Item>
</List>
<Title order={3}>Project Managers</Title>
<List>
<List.Item>
<Anchor href='https://ase.cit.tum.de/people/krusche/' target='_blank' rel='noreferrer'>
Stephan Krusche
</Anchor>
</List.Item>
</List>
<Title order={3}>Contributors</Title>
<List>
<List.Item>
Expand Down Expand Up @@ -47,6 +70,15 @@ const AboutPage = () => {
<Center>
<Image src={flowchart} style={{ maxWidth: '600px' }} />
</Center>
<Title order={3}>Git Information</Title>
<List>
<List.Item>
Branch: <b>{GLOBAL_CONFIG.git.branch}</b>
</List.Item>
<List.Item>
Commit: <b>{GLOBAL_CONFIG.git.commit}</b>
</List.Item>
</List>
</Stack>
</PublicArea>
)
Expand Down
4 changes: 4 additions & 0 deletions docker-compose.prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ services:
- CALDAV_USERNAME
- CALDAV_PASSWORD
- SCIENTIFIC_WRITING_GUIDE
- GIT_COMMIT
- GIT_BRANCH
networks:
- thesis-track-network

Expand Down Expand Up @@ -109,6 +111,8 @@ services:
- APPLICATION_TITLE
- CHAIR_NAME
- CHAIR_URL
- GIT_COMMIT
- GIT_BRANCH
depends_on:
- server
networks:
Expand Down
2 changes: 0 additions & 2 deletions server/build.gradle
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

plugins {
id "java"
id "idea"
// id "com.gorylenko.gradle-git-properties" version "2.4.2"
id "com.github.andygoossens.modernizer" version "1.10.0"
id "org.springframework.boot" version "${spring_boot_version}"
id "io.spring.dependency-management" version "1.1.6"
Expand Down

0 comments on commit c98295e

Please sign in to comment.