Thesis Management System

Overview | How to run the project | Credentials | Frontend Documentation | Backend Documentation | Database Documentation | Contributors

Overview

Welcome to our project! We're thrilled to have you here.

We are Group 9, and we're excited to present our innovative software designed to simplify the lives of students and teachers!

Our software offers a comprehensive suite of features, including the ability to create and manage thesis proposals, submit and handle students' applications and students' thesis start requests. It also comes with a stunning integrated email notification system and a visually appealing mobile interface for convenience and ease of use!

How to run the Project

Set up environmental variables | Backend Setup | Frontend Setup | Use Docker

Set up environmental variables

In order to work properly, the application requires the following environment variables to be set:

• TM_SMTP_SERVICE_NAME = The name of the SMTP service to use (e.g. "gmail")
• TM_SMTP_HOST = The host of the SMTP service to use (e.g. "smtp.gmail.com")
• TM_SMTP_USERNAME = The username of the SMTP service to use (e.g. the email address for a Gmail account)
• TM_SMTP_PASSWORD = The password of the SMTP service to use
• TM_SMTP_PORT = The port of the SMTP service to use (e.g. 587)
• TM_SMTP_SECURE = Whether to use a secure connection to the SMTP service (e.g. "true")

⚠️ The service supports the use of dotenv-vault and therefore allows you to set only one environment variable: TM_DOTENV_KEY. This variable must contain the key to decrypt the environment variables stored in the dotenv-vault file.

---

Backend Setup

Execute the following commands in a Command Shell:

cd backend - Enter the folder

npm install - Install all the dependencies

npm start - Start the server

⚠️ If you don't have npm installed you can download it from here: npm

---

Frontend Setup

Execute the following commands in a Command Shell:

cd front-end - Enter the folder

npm install - Install all the dependencies

npm run build - Build the project for production

npm run preview - Preview the production build

⚠️ If you don't have npm installed you can download it from here

---

Docker

This project supports the use of Docker to run the application. Beware that you still need to set up environmental variables. The following instructions assume that you already have Docker correctly installed on your machine:

docker build -t apokalypt/09_thesis_management . - Build the image

docker run -p 5173:5173 -p 3000:3000 --name thesis_management -e <...> apokalypt/09_thesis_management - Run the container

⚠️ A working image is available on Docker Hub

Credentials

Student

[email protected] | s320213

Secretary Clerk

[email protected] | sc12345

Teacher (and tester)

[email protected] | d279620

Frontend Documentation

For a more datailed documentation regarding the Frontend, please read here

Backend Documentation

For a more datailed documentation regarding the Backend, please read here

Database Documentation

For a more datailed documentation regarding the Database, please read here

Contributors

Barbato Luca (320213) | Beltrán Juan Carlos (321607) | De Rossi Daniele (314796) | Husanu Diana Alexandra (318771) | Ladrat Mattéo (321529) | Molinatto Sylvie (318952) | Schiavone Michele (319355)