> For the complete documentation index, see [llms.txt](https://hossams-organization-1.gitbook.io/edulink/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hossams-organization-1.gitbook.io/edulink/chapter-5-user-guide.md).

# Chapter 5: User Guide

## How To Getting Started with EduLink Application?<br>

### 1-How to Install (For End Users)

#### Android Installation (APK)

1. Go to the [`/exe`](https://github.com/YousefSaber128/edulink/blob/main/exe) folder or visit the [GitHub Releases](https://github.com/YousefSaber128/edulink/releases/tag/APK).
2. Download the file: `EduLink.apk`
3. Transfer the APK to your Android phone.
4. On your phone:
   * Tap the APK
   * Accept the "Install from unknown sources" prompt if shown
5. Launch the app and enjoy!

> ⚠️ APK is for Android only. iOS is currently not supported

### 2-Developer Setup (Run from Source)

1. Clone the project repository from GitHub.

```
git clone https://github.com/YousefSaber128/edulink.git
cd edulink
flutter pub get
flutter run

```

&#x20;2\.   Open the project using **Visual Studio Code** or **Android Studio**.

3. Ensure required tools (below) are installed.
4. Connect a device or emulator and run `flutter run`.

## Required Tools

* Dart SDK (compatible with Flutter version)
* Supabase For Cloud Storage
* Flutter SDK (version >= 3.10.0)
* Android Studio or VS Code with Flutter extension
* Firebase project with configured services:
  * Authentication
  * Firestore
  * Push Notification

***

## Downloading the Project <a href="#id-2.1-downloading-the-project" id="id-2.1-downloading-the-project"></a>

&#x20;from the following Google Drive link download the entire project folder:

🔗 [**Download Project Files**](https://drive.google.com/drive/folders/1KlsRQKR5p3R1Bdp7N0vltddbvNVukp22?usp=drive_link)

> Note: Make sure you are logged into a Google account with access permissions. If access is restricted, simply request permission from the link above.

***

### How to Use the Application <a href="#id-2.5-how-to-use-the-application" id="id-2.5-how-to-use-the-application"></a>

* Login/Signup: Users sign in as students or professors
  * (Google , Facebook sign-in supported)
* **Students:** Apply for courses, access grouped materials, post in course Q\&A, and chat with professors and others students.
* **Professors:** Create/manage courses, add/edit materials, moderate Q\&A posts, and access their profile.

***

## Project Demo Video <a href="#id-2.1-downloading-the-project" id="id-2.1-downloading-the-project"></a>

Click below to explore our app demo of **EduLink**&#x20;

<a href="https://drive.google.com/drive/u/2/folders/1lP-p3dFTPAnnhGFHpKyJ0RM1xzHjOnMH" class="button secondary">Watch Demo</a>

***

### Notes & Considerations <a href="#id-2.6-notes-and-considerations" id="id-2.6-notes-and-considerations"></a>

* The application’s performance may occasionally experience slight delays when syncing updates, depending on the user’s internet connection speed.
* EduLink is developed solely as a graduation project for educational purposes and is not intended for commercial use or broader deployment

***