Skip to content

Hayredin950/Al-Muhandis

Repository files navigation

Al Muhandis Logo

🚀 Al Muhandis

AI-Powered Islamic Knowledge Platform for Quran, Hadith, and More

GitHub license GitHub stars GitHub forks TypeScript React Tailwind CSS


✨ Key Features

📖 Quran & Mushaf Experience

  • Beautiful Mushaf Interface: Elegant, clean Quran reader
  • Tajweed Highlighting: Proper color-coded tajweed rules
  • Multiple Translations: Access to various Quran translations
  • Tafseer Integration: Detailed tafseer of each verse
  • Hifz Tracker: Memorization tracking and progress

📜 Hadith Exploration

  • Multiple Collections: Access to major hadith collections
  • Grading System: Hadith grading (sahih, hasan, da'if, etc.)
  • Isnad Visualization: Beautiful isnad chain display
  • Weak Hadith Identification: Flag weak hadiths with explanations
  • Topic-Based Search: Find hadiths by specific topics

🤖 AI Scholar Assistant

  • Ask Scholar: Ask questions about Islamic knowledge
  • Contextual Answers: AI responses based on Quran and Hadith
  • Source Citations: All answers reference authentic sources
  • Natural Language: Ask questions in English or Arabic

📚 Knowledge Organization

  • Bookmarks: Save your favorite verses and hadiths
  • Collections: Create custom collections of content
  • Reading Goals: Set and track your reading goals
  • Search & Analytics: Powerful search and reading analytics
  • Profile: Customize your personal Islamic learning profile

💻 Modern Stack

  • Type-Safe: Full TypeScript implementation
  • API-First: RESTful API with OpenAPI documentation
  • Modern UI: Beautiful, responsive interface with Tailwind CSS
  • Fast & Optimized: Built with Vite and React

🛠️ Tech Stack

Layer Technologies
Frontend React, TypeScript, Vite, Tailwind CSS
Backend API Node.js, Express, TypeScript
Database Drizzle ORM, PostgreSQL, SQLite
AI Integration OpenAI API, LangChain
Testing Vitest, Playwright
Tools pnpm, ESLint, Prettier
API Docs OpenAPI, Swagger UI

🚀 Quick Start

Prerequisites

  • Node.js 18+
  • pnpm
  • PostgreSQL 15+ (optional, SQLite by default)

Installation

# Clone the repository
git clone https://github.com/Hayredin950/Al-Muhandis.git
cd Al-Muhandis

# Install dependencies
pnpm install

# Start the API server
cd artifacts/api-server
pnpm install
pnpm dev

# In another terminal, start the frontend
cd artifacts/al-muhandis
pnpm install
pnpm dev

# Open your browser at http://localhost:5173

Configuration

Create a .env file in the root:

# OpenAI API for AI Scholar
OPENAI_API_KEY=your_openai_api_key

# Database (optional, default is SQLite)
DATABASE_URL=postgresql://user:password@localhost:5432/al_muhandis

📂 Project Structure

Al-Muhandis/
├── artifacts/
│   ├── al-muhandis/     # Main React frontend
│   ├── api-server/      # Backend API
│   └── mockup-sandbox/  # Design mockup tools
├── lib/                 # Shared libraries
│   ├── api-client-react/ # React API client
│   ├── api-spec/        # OpenAPI specification
│   ├── api-zod/         # Type-safe API schemas
│   ├── db/              # Database schema (Drizzle)
│   └── integrations-openai/ # OpenAI integration
├── scripts/             # Seed and utility scripts
└── ...

🌟 Highlights

  • Production-Ready: Scalable architecture
  • Clean Code: TypeScript and proper code organization
  • Open Source: MIT-licensed
  • Beautiful UI: Modern, elegant interface
  • Comprehensive Docs: Well-documented for developers
  • AI-Powered: Cutting-edge AI integration
  • Quran & Hadith: Authentic Islamic knowledge resources

📄 License

MIT © Hayredin950

📞 Contact


Made with ❤️ for the Muslim Ummah by Hayredin950

About

Al-Muhandis: AI-Powered Islamic Intelligence Platform

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages