tawafmesar / UmrahEasier

UmrahEasier 🕋 is a Flutter app that designed to assist pilgrims throughout their Umrah journey. Built with Flutter, PHP, and MySQL,

UmrahEasier 🕋

UmrahEasier is a comprehensive guide designed to assist pilgrims throughout their Umrah journey. This application offers detailed step-by-step instructions and essential information, ensuring a smooth and fulfilling experience. From entering ihram at designated miqat locations to completing the entire Umrah, UmrahEasier is your perfect companion.

Features ✨

• Step-by-Step Instructions: Detailed guidance from the beginning to the end of your Umrah journey.
• Loop Counter: Track the number of loops completed during Tawaf.
• Essential Information: Everything you need to know about performing Umrah correctly.

Getting Started 🚀

To get a local copy of this project up and running, follow these steps:

1. Clone the repository:

   bash git clone https://github.com/tawafmesar/UmrahEasier.git

2. Set up the backend:

   • Navigate to the backend scripts provided in the repository:

     bash git clone https://github.com/tawafmesar/UmrahEasierBackend.git

   • Configure your PHP environment to host the backend scripts.

   • Import the MySQL database schema provided in the umreas_umrahheasierdb.sql.

3. Run the Flutter application:

   • Open the project in your preferred Flutter IDE.
   • Connect the Flutter app to your configured backend endpoints.

Installation 🛠️

Prerequisites

• Flutter: Ensure Flutter is installed on your system. Follow the Flutter installation guide if you haven't set it up yet.
• PHP: Install a PHP server (e.g., XAMPP, WAMP, MAMP) to host the backend scripts.
• MySQL: Ensure MySQL is installed and running for database operations.

Steps

1. Clone the repository:

   bash git clone https://github.com/tawafmesar/UmrahEasier.git

2. Backend setup:

   • Clone the backend repository:

     bash git clone https://github.com/tawafmesar/UmrahEasierBackend.git

   • Set up your PHP environment and import the MySQL database schema.

3. Run the Flutter application:

   • Open the project in your preferred Flutter IDE.
   • Update the backend URLs in your Flutter project to point to your local or deployed backend.
   • Run the application on an emulator or a physical device.

Screenshots 📱

Contributing 🤝

Contributions are welcome! Please fork the repository and submit a pull request with your changes.

License 📄

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