# Overview

## Introduction

This project aimed to help students of BIS-HU in their learning journey by providing services that can be redeemed as helpful and useful.

***

## Problems & Solutions

<details>

<summary>Problems</summary>

We noticed some things at our university that could be better. For example, students often struggle with confusing processes and don't always have the right support to do well in their studies.

We're trying to make different options to help our friends at university by finding new ways to make learning easier.

</details>

<details>

<summary>Solutions</summary>

Our Portal offers different helpful services.

One thing it does is give students regular updates about their professors and classes.

Another thing our Portal does is analyze students' grades to see how they're doing. It looks at their grades over time and shows them where they're doing well and where they might need to work harder.

This helps students understand how they're doing in their classes and how they can improve their GPA.

</details>

***

## Audience or target users for the documentation

Students within the Business Information Systems department at Helwan University in Cairo, Egypt, are the primary audience for our solution.\
\
Given their academic focus on business information systems, target users within this department are likely to be analytical, detail-oriented, and proactive in seeking solutions to challenges they encounter in their studies.

***

## Team :people\_hugging:

| Team members     | Role                         |
| ---------------- | ---------------------------- |
| Yousef Abodawoud | Front-end developer (leader) |
| Hoda Abdel Qader | Front-end developer          |
| Yousef Ahmed     | Back-end developer (leader)  |
| Ziad Ehab        | Back-end developer           |

***

### The next section \[Phases] will be divided into three parts

{% tabs %}
{% tab title="First" %}
{% content-ref url="phases/design-system-style-guide" %}
[design-system-style-guide](https://bis-helper.gitbook.io/bis-helper-docs/readme/phases/design-system-style-guide)
{% endcontent-ref %}

* Explanation of the design principles and philosophy.
* Components included in the design system.
* Guidelines for using colors, typography, icons, spacing, etc.
* Examples and code snippets for implementing the design system.
  {% endtab %}

{% tab title="Second" %}
{% content-ref url="phases/ui-ux" %}
[ui-ux](https://bis-helper.gitbook.io/bis-helper-docs/readme/phases/ui-ux)
{% endcontent-ref %}

* Wireframes: Introduction to wireframing and its importance.
* Low-fidelity: Explanation of low-fidelity prototyping and its benefits.
* High-fidelity: Description of high-fidelity prototyping and its role in the design process.
* Prototypes: How prototypes are created and their significance in user testing and feedback gathering.
* Integration of design prototypes with development.
  {% endtab %}

{% tab title="Third" %}
{% content-ref url="phases/technical" %}
[technical](https://bis-helper.gitbook.io/bis-helper-docs/readme/phases/technical)
{% endcontent-ref %}

* Coding: Overview of the coding practices followed in the project.
* API Reference: Documentation of APIs used in the project, including endpoints, request/response formats, authentication, etc.
* Integration of front-end components with back-end services.
* Deployment processes and best practices.
  {% endtab %}
  {% endtabs %}
