Skip to content

Latest commit

 

History

History
130 lines (79 loc) · 3.28 KB

README.md

File metadata and controls

130 lines (79 loc) · 3.28 KB

🎓 TheStudentMaster

📖 Project Description

TheStudentMaster is a project developed to facilitate the daily lives of students at the Cooperative State University Baden-Württemberg (DHBW). The app offers various features and services tailored specifically to student needs. It is being developed by a group of six students enrolled in the Cyber Security program at DHBW.

📲 Download TheStudentMaster

TheStudentMaster is available on both iOS and Android platforms. Download the app using the following links:

🌟 Planned Features

  • 🗓️ Timetable Management: Manage your timetables, check lecture times, and quickly capture changes.

  • 🍽️ Cafeteria Menu: Get an overview of cafeteria menus to help plan your meals.

  • 🚦 Cafeteria Occupancy: View predicted occupancy of the cafeteria to choose times with less waiting.

  • 📊 Integration with Dualis: Connect to the Dualis platform for quick access to your grades.

  • 🏫 Available Rooms: Identify available rooms for study purposes.

👥 Contributors

  • Andreas Schütz (Backend Lead)
  • Leon Sylvester (Frontend Lead)
  • Andreas Wolf (Backend, CI/CD)
  • Julian Gardeike (inactive)
  • Daniel Hecht (inactive)
  • Kasimir Weilandt (inactive)

🚀 Getting Started

This is the quick start guide for the front end of TheStudentMaster.

📱 Frontend

⚠️ Please note: You must have Node v20 (LTS) or Node v21 installed on your computer to run the frontend application. You also need either an iOS/Android emulator or a corresponding device. For a simple test of this app, we recommend installing Expo Go from the Apple App Store or Google Play Store on your device.

Installation and Setup

  1. Clone the repository:

    git clone https://gitlab.com/themastercollection/thestudentmaster.git

  2. Go to the client folder:

    cd ./thestudentmaster/Client

  3. Install all required node packages:

    npm install

  4. Start the Expo Dev Server:

    npm run start -c

  5. Run the App:

    • Scan the QR code displayed with your iOS or Android device.
      • iOS: Scan the QR code with the Camera app.
      • Android: Scan the code directly in the Expo Go app.
    • For the web version, press w in the terminal.

    ⚠️ Note: The web version will not compile on Windows. This is a known issue.

🖥️ Backend

⚠️ Please note: You must have Python >= v3.11 installed on your computer to run the backend application.

Installation and Setup

  1. Clone the repository:

    npm run start -c

  2. Go to the server folder:

    cd ./thestudentmaster/Server

  3. Install all required Python modules:

    pip install -r requirements.txt

  4. Start the Backend:

    uvicorn main:app --reload

    or

    python uvicorn main:app --reload

📬 Support and Feedback

For support or feedback regarding TheStudentMaster, please contact the development team at 📧 support@thestudentmaster.de