Skip to content
Prompt

alfanous — Copilot Instructions

by Alfanous-team

AI Summary

Alfanous is a search engine API for the Holy Qur'an that provides simple and advanced search capabilities. The project is written in Python and uses Whoosh for indexing and search functionality. 1. Install dependencies: 2. Generate required configuration (use VERSION from Makefile):

Install

Copy this and paste it into Claude Code, Cursor, or any AI assistant:

I want to add the "alfanous — Copilot Instructions" prompt rules to my project.
Repository: https://github.com/Alfanous-team/alfanous

Please read the repo to find the rules/prompt file, then:
1. Download it to the correct location (.cursorrules, .windsurfrules, .github/prompts/, or project root — based on the file type)
2. If there's an existing rules file, merge the new rules in rather than overwriting
3. Confirm what was added

Description

Alfanous is an Arabic search engine API provides the simple and advanced search in Quran , more features and many interfaces...

Project Overview

Alfanous is a search engine API for the Holy Qur'an that provides simple and advanced search capabilities. The project is written in Python and uses Whoosh for indexing and search functionality.

Makefile Usage

• Use Makefile for building, not manual commands • Key targets: • make build - Build indexes • make clean - Clean temporary files • make install - Install package locally • make dist - Create distribution packages

Technology Stack

• Language: Python 3.8+ • Core Dependencies: pyparsing, whoosh • Testing Framework: pytest • License: LGPL v3 or later

Project Structure

` alfanous/ ├── src/ │ ├── alfanous/ # Main API package │ │ ├── api.py # Main API interface │ │ ├── engines.py # Search engines │ │ ├── outputs.py # Output formatting │ │ ├── indexing.py # Index management │ │ ├── searching.py # Search functionality │ │ ├── Support/ # Support libraries │ │ │ └── pyarabic/ # Arabic text processing │ │ ├── configs/ # Configuration files │ │ ├── resources/ # Static resources │ │ └── indexes/ # Search indexes │ ├── alfanous_import/ # Data import tools │ └── tests/ # Test suite ├── store/ # Quranic data storage └── Makefile # Build and deployment commands `

Discussion

0/2000
Loading comments...

Health Signals

MaintenanceCommitted 6d ago
Active
Adoption100+ stars on GitHub
285 ★ · Growing
DocsREADME + description
Well-documented

GitHub Signals

Stars285
Forks91
Issues23
Updated6d ago
View on GitHub
LGPL-3.0 License

My Fox Den

Community Rating

Sign in to rate this booster

Works With

Any AI assistant that accepts custom rules or system prompts

Claude
ChatGPT
Cursor
Windsurf
Copilot
+ more