Skip to content

GitWithQA transforms any GitHub repository into an interactive Q&A knowledge base. Instantly explore code, ask questions, and get answers powered by LLMs—no setup required.

License

Notifications You must be signed in to change notification settings

raselmeya94/gitwithqa

Repository files navigation

Image Image

License GitHub issues Code style: black Discord

GitWithQA

GitWithQA enhances any GitHub repository by turning it into an interactive, intelligent Q&A knowledge base—perfect for developers, teams, and LLM applications.

Now supercharged with LLM chat integration, GitWithQA allows users to ask questions, explore code, and discuss functionality directly within the platform—no extra setup required. Whether you're trying to understand what a specific file does, what a function is responsible for, or simply exploring the codebase, GitWithQA makes it seamless and intuitive.

🔗 Try it live: gitwithqa.comShortcut: Just replace hub with withqa in any GitHub URL to get instant Q&A insights!


🚀 What’s New

  • 💬 Interactive LLM Chat: Instantly ask questions and get answers from the full merged repository content. Perfect for code understanding, documentation lookup, and general discussion.
  • 🔎 Smart Context Awareness: Get meaningful answers based on function roles, file responsibilities, and more.
  • 🎯 RAG Integration (Coming Soon): Enhanced Retrieval-Augmented Generation will ensure even more accurate, context-aware answers to your queries.
  • 📦 Powered by gitingest: Leverages gitingest's structured file merge and preprocessing to enable deep understanding across the codebase.

🔧 Core Features

  • 🔍 Extracts Q&A pairs from code, docstrings, markdown, and comments
  • 🧠 Chat-ready interface for real-time conversation with your repo
  • ⚙️ Token-aware chunking using tiktoken
  • 🧱 Built to integrate into any RAG pipeline
  • 🌐 Frontend with Tailwind CSS
  • ⚡ FastAPI backend
  • 📊 Usage analytics via APIAnalytics.dev

🛠 Tech Stack

Layer Technology
Frontend Tailwind CSS
Backend FastAPI
Tokenizer OpenAI tiktoken
Analytics API Analytics
Style Guide black
LLM OpenAI, Gemini

⚙️ Getting Started

1. Clone the Repository

git clone https://github.com/raselmeya94/gitwithqa.git
cd gitwithqa

2. Install Dependencies

pip install -r requirements.txt

3. Run the Application Locally

cd src
uvicorn main:app --reload

Visit http://localhost:8000 to view the application.


🌍 Configuration

Environment Variables

Set your environment variables to configure the host:

ALLOWED_HOSTS="gitwithqa.local,localhost"

🤝 Contributing

We welcome and encourage contributions! Whether you’re fixing a bug, adding features, or improving documentation, your help is appreciated.

How to Contribute

  1. 💡 Share feedback and ideas on Discord

  2. 🐞 Open an issue to report bugs or request features

  3. 📤 Submit a pull request:

    • Fork the repo
    • Make your changes
    • Test locally
    • Submit a PR for review

Code Guidelines

  • Follow Black for formatting
  • Use descriptive commit messages
  • Keep PRs focused and well-scoped

💡 Use Cases

  • Fine-tune LLMs on your organization’s codebase
  • Enhance RAG applications with Git-aware knowledge
  • Automatically generate developer FAQs
  • Build code-aware assistants or bots

⚠️ Note

GitWithQA is an experimental fork of gitingest. Some internal folder names and structures still reference gitingest. These will be progressively updated to match the GitWithQA branding and scope.


📜 License

This project is licensed under the MIT License. See the LICENSE file for details.


🌐 Community

Have questions or want to collaborate? Join our community:


✨ Inspiration

GitWithQA was created to bridge the gap between developer code and AI understanding by turning real-world repositories into structured training data for LLMs and RAG systems.


Built with ❤️ by @raselmeya94

About

GitWithQA transforms any GitHub repository into an interactive Q&A knowledge base. Instantly explore code, ask questions, and get answers powered by LLMs—no setup required.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published