Student Guide

university companion application designed to enhance student experience by centralizing essential university information into a single, user-friendly platform. Our project aims to provide students with a professional tool for accessing critical university-related data and leveraging a range of functional features tailored to their academic needs.

Screenshots

Tools & Technologies

• vanilla js: for the front-end
• Node.js: for the back-end
• MongoDB: for the database

Features

• Location: Provides detailed information about each Office, including its description, email, and location.
• TA Directory:Allows students to get all data about their TAs including their office number, office hours and their emails.
• Courses: Provide students with comprehensive resources and guidance from experienced peers through a visually appealing page layout.
• Schedules: Enable students to conveniently view all CS department schedules at a glance.
• Grade Calculator: Simplify the process for students to calculate their coursework and overall grades within a single course effortlessly.
• GPA Calc: Empower students to seamlessly and effortlessly calculate their GPA.
• Resources Gateway: Centralize essential links and tools for easy access to important resources.

Installation and Usage

To run the project locally, follow these steps:

1. Clone the repository:

git  clone  https://github.com/AhmedHosny2/Student-Guide

2.Navigate to the Microservice Directories:

cd UserMicroservice
cd CoursesMicroservice
cd TADirectoryMicroservice

3.Install Dependencies:

npm i

4. Set up the environment variables:

User Microservice:

-   cp UserMicroservice/.env.example UserMicroservice/.env 

• Courses Microservice:

-   cp CoursesMicroservice/.env.example CoursesMicroservice/.env

• TADirectory Microservice:

cp TADirectoryMicroservice/.env.example TADirectoryMicroservice/.env

Then, fill in the required variables in the .env file.

4. Run the development server:

python runAll

This microservice project consists of three services, each running on a designated port:

User Microservice

Port: 5001

Courses Microservice

Port: 5002

TADirectory Microservice

Port: 5003

Meet the Team

Name	Role	GitHub
Ahmed Yehia	Backend Developer	@AhmedHosny2
Abdelrahman Elkhateeb	Frontend Developer	@abdelrahman-elkhateeb
Mohamed Tamer	Frontend Developer	@MooTamer

Contribution 👀

1. Assign Yourself a Task: Head over to our Trello board and assign yourself a task that you'd like to work on.

2. Create a Pull Request: Once you've chosen a task and made your changes, create a Pull Request (PR) in this repository.

3. Review Process: Your PR will be reviewed promptly.

4. Merge: After review, your updates will be merged into the project as soon as possible, insha'Allah.