{"id":24570394,"url":"https://github.com/md-abid-hussain/docquery","last_synced_at":"2025-10-25T06:08:02.497Z","repository":{"id":273426424,"uuid":"919678031","full_name":"md-abid-hussain/docquery","owner":"md-abid-hussain","description":"DocQuery: Turn your documentation markdown to knowledgebase","archived":false,"fork":false,"pushed_at":"2025-09-14T14:55:59.000Z","size":1732,"stargazers_count":19,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-02T18:59:08.277Z","etag":null,"topics":["copilotkit","gemini","genai","langgraph-python","mongodb","nextjs","rag","shadcn-ui","togetherai"],"latest_commit_sha":null,"homepage":"https://docquery-ten.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/md-abid-hussain.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-20T20:00:31.000Z","updated_at":"2025-09-14T14:55:56.000Z","dependencies_parsed_at":"2025-01-20T21:33:50.356Z","dependency_job_id":"1be0625e-2a1d-41df-8a72-65391702d4c9","html_url":"https://github.com/md-abid-hussain/docquery","commit_stats":null,"previous_names":["md-abid-hussain/docquery"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/md-abid-hussain/docquery","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/md-abid-hussain%2Fdocquery","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/md-abid-hussain%2Fdocquery/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/md-abid-hussain%2Fdocquery/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/md-abid-hussain%2Fdocquery/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/md-abid-hussain","download_url":"https://codeload.github.com/md-abid-hussain/docquery/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/md-abid-hussain%2Fdocquery/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280911901,"owners_count":26412337,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-25T02:00:06.499Z","response_time":81,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["copilotkit","gemini","genai","langgraph-python","mongodb","nextjs","rag","shadcn-ui","togetherai"],"created_at":"2025-01-23T16:19:36.605Z","updated_at":"2025-10-25T06:08:02.465Z","avatar_url":"https://github.com/md-abid-hussain.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DocQuery\n\n## Overview\n\nDocQuery is a comprehensive project consisting of both frontend and backend components. The frontend is built with Next.js and Tailwind CSS, providing a user-friendly interface to create powerful knowledge bases for LLMs using markdown documentation. The backend leverages FastAPI to provide endpoints for different agents built using the `langgraph` library and integrated into the FastAPI application using `CopilotKitSDK`.\n\n## Video: Click to view\n\n[![Youtube Video](https://img.youtube.com/vi/nYDthsB8d7I/maxresdefault.jpg)](https://youtu.be/nYDthsB8d7I?si=uOEHGZB2A7DRpMsn)\n\n## Setup\n\n### Frontend\n\n1. Clone the repository:\n\n    ```sh\n    git clone https://github.com/md-abid-hussain/docquery.git\n    cd docquery-frontend\n    ```\n\n2. Install dependencies:\n\n    ```sh\n    npm install\n    ```\n\n3. Copy the example environment file and fill in the required values:\n\n    ```sh\n    cp .env.example .env\n    ```\n\n4. Start the development server:\n\n    ```sh\n    npm run dev\n    ```\n\n5. The application will be available at `http://localhost:3000`.\n\n### Backend\n\n1. Clone the repository:\n\n    ```sh\n    git clone \u003crepository-url\u003e\n    cd docquery-backend\n    ```\n\n2. Create and activate a virtual environment:\n\n    ```sh\n    python -m venv venv\n    source venv/bin/activate  # On Windows use `venv\\Scripts\\activate`\n    ```\n\n3. Install dependencies:\n\n    ```sh\n    pip install -r requirements.txt\n    ```\n\n4. Copy the example environment file and fill in the required values:\n\n    ```sh\n    cp .env.example .env\n    ```\n\n5. Start the FastAPI server:\n\n    ```sh\n    uvicorn app.main:app --reload\n    ```\n\n6. The application will be available at `http://127.0.0.1:8000`.\n\n## Features\n\n### Frontend\n\n- **GitHub Integration**: Easily fetch repository details and select markdown files for ingestion.\n- **Markdown Processing**: Ingest and process markdown files used for documentation or detailed explanations.\n- **Knowledge Base Creation**: Build comprehensive knowledge bases for LLMs from your documentation.\n- **AI-Powered Insights**: Leverage advanced LLMs to generate insights and answer queries based on your knowledge base.\n\n### Backend\n\n#### Ingestion Agent\n\nThe Ingestion Agent is defined in agent.py. It consists of the following nodes:\n\n- `Ingestion Node`\n- `Verify Ingestion Node`\n\n#### QA Agent\n\nThe QA Agent is defined in agent.py. It consists of the following nodes:\n\n- `Retrieve Node`\n- `Chat Node`\n\n## API Endpoints\n\n- `GET /`: Returns a simple greeting message.\n- `POST /copilotkit`: Endpoint for interacting with the agents.\n\n## Environment Variables\n\nThe application requires the following environment variables to be set:\n\n### Frontend\n\n- `TOGETHER_AI_API_KEY`\n- `DATABASE_URL`\n\n### Backend\n\n- `GOOGLE_API_KEY`\n- `TOGETHER_API_KEY`\n- `GITHUB_PERSONAL_ACCESS_TOKEN`\n- `MONGODB_ATLAS_CLUSTER_URI`\n\nThese can be set in the respective `.env` files.\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmd-abid-hussain%2Fdocquery","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmd-abid-hussain%2Fdocquery","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmd-abid-hussain%2Fdocquery/lists"}