Skip to content

Beyond Knowledge, Towards Wisdom: A privacy-first AI Islamic research assistant that sources guidance exclusively from IslamQA.info and IslamWeb.net.

License

Notifications You must be signed in to change notification settings

mdselimdev/perspicacity

Perspicacity 🕌

License: MIT Live Demo PWA Ready Support on Ko-fi

Beyond Knowledge, Towards Wisdom

Perspicacity is an AI-powered Islamic research assistant designed to provide reliable guidance by sourcing answers exclusively from trusted Islamic websites (IslamQA.info and IslamWeb.net). It features dual search modes, conversation memory, and a privacy-first architecture where your API keys never leave your browser.

🌐 Live Demo: perspicacity.is-cool.dev

✨ Key Features

  • 🔍 Dual Modes:
    • Quick Search: Immediate, sourced answers for everyday questions.
    • Deep Research: Comprehensive, multi-step analysis for complex topics.
  • 📚 Trusted Sources: Information is exclusively sourced from IslamQA.info and IslamWeb.net to ensure reliability.
  • 🛡️ Privacy-First: Serverless architecture means your API keys are stored locally in your browser and never transmitted to us.
  • 🧠 Contextual Memory: The assistant remembers your conversation for relevant follow-up questions.
  • 📱 Progressive Web App (PWA): Installable on iOS, Android, and Desktop for a native app experience.

🚀 Quick Start

  1. Visit perspicacity.is-cool.dev.
  2. Click the settings icon (⚙️) in the top right.
  3. Enter your free API keys (instructions below) and click "Save Settings".
  4. Start asking your questions!

🔑 Getting Free API Keys

Perspicacity requires two free API keys to function. These keys are stored only on your device.

1. Gemini API Key (for AI reasoning)

  1. Visit Google AI Studio.
  2. Sign in with your Google account.
  3. Click "Create API Key".
  4. Copy the key and paste it into Perspicacity settings.

2. Google Cloud API Key (for searching trusted sites)

  1. Go to Google Cloud Console.
  2. Create a new project (or select an existing one).
  3. Enable the "Custom Search API".
  4. Go to Credentials → "Create Credentials""API Key".
  5. Copy the key and paste it into Perspicacity settings.

📱 Installation (PWA)

Perspicacity is designed to be installed as a native app on your device.

Platform Instructions
iOS Open in Safari → Tap 'Share' icon → "Add to Home Screen"
Android Open in Chrome → Tap menu (⋮) → "Add to Home Screen" / "Install App"
Desktop Open in Chrome/Edge → Click the install icon in the address bar

🛠️ Local Development

To run the project locally for development or contribution:

# Clone the repository
git clone https://github.com/mdselimdev/perspicacity.git

# Navigate to directory
cd perspicacity

# Start a simple local server (requires Python)
python3 -m http.server 8000

Open your browser to http://localhost:8000.

🤝 Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines on how to report issues, suggest features, or submit pull requests.

💖 Support the Project

If Perspicacity has benefited your Islamic learning journey, please consider supporting its continued development.

  • Support on Ko-fi
  • ⭐ Star this repository on GitHub
  • 🔄 Share it with your community

📄 License

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

🙏 Acknowledgments

  • Sources: Grateful acknowledgment to IslamQA.info and IslamWeb.net for their invaluable scholarly resources.
  • Technology: Powered by Google Gemini and Google Custom Search.

Made with ❤️ for the Muslim Ummah

About

Beyond Knowledge, Towards Wisdom: A privacy-first AI Islamic research assistant that sources guidance exclusively from IslamQA.info and IslamWeb.net.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published