Quran, hadith and names of Allah all in one app and API.

The Reminder is an API and app for the Quran, Hadith (Bukhari) and Names of Allah. It provides search summarisation using OpenAI and RAG context referencing. The goal is to consolidate these texts and information into a single API and app and leverage LLMs as a tool for searching. We do not offload reasoning to LLMs but they are a new form of useful indexing for search.

• Quran in English & Arabic
• Names of Allah & Meaning
• Hadith (Bukhari) in English
• Index & Search using GPT 4o
• RAG contextual referencing
• API to query LLM or Quran

Find the latest release

Or Go install

go get github.com.com/asim/reminder@latest

Set the OPENAI_API_KEY value

export OPENAI_API_KEY=xxx

Run the http server

reminder --serve

Go to localhost:8080

All queries are returned as JSON

• /api/quran - to get the entire quran
• /api/names - to get the list of names
• /api/hadith - to get the entire hadith
• /api/search - to get summarised answer
  • q param for the query
  • POST using content-type as application/json
  • curl -d '{"q": "what is islam"}' http://localhost:8080/api/search

See /api for more details

To run the react based web app

# requires pnpm
make setup

Build the app

make build

Pass the additional --web flag which will replace the built in Go app with the react app

reminder --web --serve

The Quran says in 6:90

Say,
“I ask no reward of you for this (Quran) —
it is a reminder to the whole world.”

Come chat on Discord