Skip to content

Thoufeeque-Rahman/hackathon-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The Muslim App

Project Overview

The Muslim App is a comprehensive Islamic web application designed to offer Muslims a distraction-free and haram-free digital space. The app provides essential Islamic tools such as prayer time notifications, Quran reading, Islamic educational and empowerment videos, and an AI-powered chatbot for Islamic guidance. The app aims to help Muslims stay focused on their spiritual journey in the modern world, away from unwanted content and ads commonly found on other platforms.

Features

  • Accurate Prayer Times: Real-time, location-based prayer notifications to keep users on track with their prayers.
  • Quran Reader: Read, listen, and study the Quran with built-in Tafsir, translations, and audio recitations.
  • Islamic Educational Videos: Access a wide variety of Islamic educational and empowerment videos from trusted scholars.
  • AI Chatbot for Islamic Guidance: An AI-powered chatbot capable of answering daily Islamic queries and providing personalized spiritual guidance.
  • Activity Tracker: Track daily spiritual activities, such as prayers and Quran reading, to monitor personal progress.
  • Haram-Free Experience: The app is free from ads, haram content, and distractions, offering a peaceful, Islamic-focused digital environment.

Technology Stack

  • Frontend: Built using React for a dynamic, responsive user interface.
  • Backend: Powered by Node.js and Express to handle server-side operations.
  • Database: MongoDB for managing user data and application content.
  • AI Integration: Leveraging machine learning to power the AI-based chatbot for real-time guidance.
  • Deployment: Hosted using Render or AWS for scalable, cloud-based deployment.
  • APIs: Al Adhan used for getting Prayer times and Hijri date. Quran API used for getting Quran - list of Surahs and Individual surah - in this app.

Installation

To set up the project locally, follow these steps:

  1. Clone the repository:
    git clone https://github.com/yourusername/the-muslim-app.git
  2. Navigate to the project directory:
    cd the-muslim-app
  3. Install dependencies:
    npm install
  4. Run the application:
    npm run dev
    This will start the application in development mode. By default, the app will run on http://localhost:3000.

Usage

After installation, you can explore the following features:

  • Prayer Times: Get real-time prayer notifications.
  • Quran Reader: Read and listen to Quran recitations.
  • AI Chatbot: Ask the AI chatbot any Islamic question for quick guidance.
  • Islamic Educational Videos: Watch videos on various Islamic topics.
  • Activity Tracker: Track your daily prayers and Quran reading activities.

Future Vision

The future vision for The Muslim App is to expand it into a fully functional Islamic Operating System (IOS), offering an entire halal ecosystem for Muslims. The future OS will feature halal-only app stores, privacy-centric solutions, and optimized content filtering to create a fully Islamic digital experience.

Contributing

We welcome contributions to The Muslim App! If you're interested in contributing, please follow these steps:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature-name
  3. Commit your changes:
    git commit -m "Description of the feature you added"
  4. Push to the branch:
    git push origin feature-name
  5. Open a pull request and describe the changes you've made.

License

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

Contact

If you have any questions or feedback, feel free to contact us at: rahman.am90@gmail.com.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors