🕋 Aoun - Hajj & Umrah Helper Platform | منصة عون لمساعدة الحجاج والمعتمرين

A web platform designed to assist pilgrims Hajj and Umrah performers with comprehensive guides, volunteer support, and translation services. The platform connects pilgrims with multilingual volunteers and provides step-by-step ritual instructions in Arabic.

---

Table of Contents

• 📊 Overview
• 🚀 Key Features
• 🛠️ Tech Stack Used
• 🗂 Project Structure
• 🖥️ Project Requirements
• ⚡ Quick Installation
• 🔧 Configuration
• 🗄 Database Setup
• ▶️ Usage
• 📸 Screenshots
• 🤝 Contributing
• 📄 License
• 🏷️ Credits
• 📞 Support and Assistance

---

📊 Overview

عون (Aoun) means "Help" or "Support" in Arabic. This platform serves as a digital companion for Muslims performing Hajj or Umrah by providing:

• Detailed ritual guides for Hajj and Umrah with step-by-step instructions
• Volunteer matching — pilgrims can find volunteers who speak their language
• Real-time translation — translate text between 50+ languages
• News updates — latest Hajj and Umrah news from Saudi Arabia
• FAQ section — answers to common questions about rituals and procedures

The interface is fully in Arabic with RTL (right-to-left) layout, catering to the primary audience of pilgrims and volunteers.

---

🚀 Key Features

✔️ Authentication

• Login — Username and password authentication
• Registration — Sign up as pilgrim (Hajj/Umrah) or volunteer
• Language selection — Volunteers can specify languages they speak (Arabic, Bengali, English, German, etc.)
• Session management — Cookie-based sessions for authenticated users

✔️ Hajj and Umrah Guide (hajj.php, umrah.php)

• Complete guide to Hajj and Umrah rituals
• Illustrated steps with images
• Covers all mandatory rites and procedures

✔️ Volunteer Connection (volunteers.php)

• Browse volunteers by language
• Filter volunteers by spoken language
• Direct WhatsApp contact links
• Display of volunteer languages, email, and contact info

✔️ Translation (translate.php)

• Multi-language text translation
• 50+ languages supported via MyMemory API
• Text-to-speech (TTS) for pronunciation
• Copy to clipboard
• Swap source and target languages

✔️ News (news.php)

• Latest Hajj and Umrah news
• Links to external news sources
• Card-based layout with images

✔️ FAQ (FAQ.php)

• Accordion-style FAQ section
• Topics: differences between Hajj and Umrah, rituals, legal rulings, proxy performance, health procedures

---

🛠️ Tech-Stack Used

---

🗂 Project Structure

📁 Aoun/
├── index.php          # Login & registration page
├── home.php           # Homepage (requires auth)
├── hajj.php           # Hajj ritual guide
├── umrah.php          # Umrah ritual guide
├── volunteers.php     # Volunteer contact / matching
├── translate.php      # Translation tool
├── news.php           # Hajj & Umrah news
├── FAQ.php            # Frequently asked questions
├── dbcon.php          # Database connection
├── 📁 css/
│   ├── style.css      # Main styles
│   └── trans_style.css # Translation page styles
├── 📁 js/
│   ├── script.js      # Login form toggle, Choices.js init
│   ├── languages.js   # Language list for registration
│   ├── countries.js   # Language codes for translation
│   └── trans_script.js # Translation logic
├── 📁 images/         # Images (Hajj, Umrah, news, user avatar)
├── 📁 docs/             # Documentation files and screenshots
├── 📁 database/
│   └── aoun.sql       # Alternative Database schema with sample data
└── README.md

---

🖥️ Project Requirements

• Operating System: Windows 10+, macOS Monterey+, or any Linux distro
• Web Browser: Chrome / Firefox / Edge (latest versions)
• 📋Runtime & Tools:
  • PHP 7.4 or higher (8.x recommended)
  • MySQL 5.7+ or MariaDB 10.4+
  • Apache (or compatible web server)
  • XAMPP (or similar local stack)

---

⚡ Quick Installation

1. Clone the Repository

   git clone <repository-url>
   cd aoun

2. Copy the Project into your web server directory

   c:\xampp\htdocs\aoun\
   

3. Start XAMPP and ensure Apache and MySQL are running.

4. Import the database (see Database Setup).

5. Configure dbcon.php with your database credentials (see Configuration).

6. Access the application in your browser:

   http://localhost/aoun/
   

---

🔧 Configuration

Database Connection (dbcon.php)

Edit dbcon.php to match your environment:

$con = mysqli_connect("localhost", "root", "", "aoun", "3308");

Parameter	Description
Host	localhost (or your DB host)
Username	root (or your MySQL user)
Password	"" (or your MySQL password)
Database	aoun
Port	3308 (default MySQL is 3306)

Translation API

The translation feature uses the free MyMemory API:

• URL: https://api.mymemory.translated.net/get
• No API key required for basic usage
• Rate limits may apply for heavy use

---

🗄 Database Setup

1. Open phpMyAdmin or MySQL CLI.

2. Import the schema file:

   -- Run the contents of database/aoun.sql

3. Tables:

   • users — id, username, email, phone, password, isVolunteer
   • users_language — id, language, user_id (foreign key to users)
   • contacts — id, name, email, message

4. Sample data is included in aoun.sql for testing.

---

▶️ Usage

For Pilgrims (Hajj/Umrah)

1. Register or log in.
2. Browse Hajj or Umrah guides for ritual instructions.
3. Use Translate to convert text between languages.
4. Go to التواصل مع المتطوعين (Contact Volunteers) to find volunteers by language.
5. Click التواصل عبر الواتساب to open WhatsApp and contact a volunteer.

For Volunteers

1. Register and select مــتـطـــوع (Volunteer).
2. Choose the languages you speak during registration.
3. Pilgrims can find and contact you via the volunteer page.

Translation

• Enter text in the source language.
• Select source and target languages.
• Click Translate Text.
• Use the speaker icon for TTS or the copy icon to copy the result.

---

📸 Screenshots

Login and Register Page

Home Page

Hajj and Umrah Pages

Volunteers Page

Translate Page

News Page

FAQ Page

See All Screenshots...

---

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

---

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

🏷️ Credits

• Bootstrap — getbootstrap.com
• Font Awesome — fontawesome.com
• Choices.js — github.com/bbbootstrap
• MyMemory — mymemory.translated.net
• Tajawal Google Font — fonts.google.com

---

📞 Support and Assistance

Getting Help

• README.md: For basic instructions
• GitHub Issues: Create an issue in the repository

Contact Information

• Developer: Abdulrahman Fadhl Ameer Saif @EngAboodSDev
• Email: abdulrahmanfadhl@gmail.com
• LinkedIn: Abdulrahman Fadhl
• Repository: GitHub Repository

---