Iqra AI Documentation

The Dynamic AI-First Computing Engine

Official documentation source for Iqra AI.
Explore the Docs »

Main Repository · Report Bug · Join Community

---

📚 Overview

This repository contains the source code for docs.iqra.bot. It is built using Fumadocs and Next.js.

The documentation covers:

• Introduction: Philosophy & Architecture.
• Platform: User Dashboard & Whitelabeling.
• Build & Deploy: The Visual Script Builder, Agents, Tools/Connections, Rag/Data & Route/Campaigns.
• Integrations: Providers, LLM/STT/TTS, Rerank, Embedding, FlowApps & Telephony.
• Developers: Self-Hosting & FlowApp Development.
• API Reference: OpenAPI based dynamic API references.

🚀 Getting Started

Prerequisites

• Node.js 20+
• npm / pnpm (preffered) / yarn

Local Development

1. Clone the repo:

   git clone https://github.com/abdofallah/IqraAI-Docs.git
   cd IqraAI-Docs

2. Install dependencies:

   pnpm install

3. Run the dev server:

   pnpm run dev

   Open http://localhost:3000 to view it in the browser.

---

🐳 Docker Deployment

We provide an official Docker image for easy deployment.

Using Docker Compose

You can spin up the documentation site locally or on your server using the included compose file.

1. Run:

   docker-compose up -d

2. Access: The docs will be available at http://localhost:5000.

Manual Build

To build the image yourself:

docker build -t iqraai/iqraai-docs .

---

📂 Project Structure

• content/docs: The actual MDX documentation files. Edit content here.
• app/: Next.js app router structure.
• public/: Static assets (images, logos).
• lib/: Fumadocs configuration and source loaders.
• v1.json: Fallback OpenAPI schema if api is down.

🤝 Contributing

Contributions are welcome!

1. Fork the Project.
2. Create your Feature Branch (git checkout -b feature/AmazingDocs).
3. Commit your Changes (git commit -m 'Add some AmazingDocs').
4. Push to the Branch (git push origin feature/AmazingDocs).
5. Open a Pull Request.