{"id":48734556,"url":"https://github.com/europanite/client_side_rag","last_synced_at":"2026-04-12T03:34:19.143Z","repository":{"id":323762525,"uuid":"1094257752","full_name":"europanite/client_side_rag","owner":"europanite","description":"Client-Side Browser-Based RAG.","archived":false,"fork":false,"pushed_at":"2025-12-15T07:15:21.000Z","size":741,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-17T01:20:29.477Z","etag":null,"topics":["browser","client-side","docker","docker-compose","embeding","expo","gpu","ingestion","llm","natural-language-processing","nlp","rag","react","react-native","retrieval-augmented-generation","typescript","web-gpu","web-llm","webgpu","webllm"],"latest_commit_sha":null,"homepage":"https://europanite.github.io/client_side_rag/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/europanite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-11T13:23:00.000Z","updated_at":"2025-12-15T07:15:24.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/europanite/client_side_rag","commit_stats":null,"previous_names":["europanite/client_side_rag"],"tags_count":0,"template":false,"template_full_name":"europanite/frontend_expo_template","purl":"pkg:github/europanite/client_side_rag","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/europanite%2Fclient_side_rag","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/europanite%2Fclient_side_rag/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/europanite%2Fclient_side_rag/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/europanite%2Fclient_side_rag/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/europanite","download_url":"https://codeload.github.com/europanite/client_side_rag/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/europanite%2Fclient_side_rag/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31703500,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-11T21:17:31.016Z","status":"online","status_checked_at":"2026-04-12T02:00:06.763Z","response_time":58,"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":["browser","client-side","docker","docker-compose","embeding","expo","gpu","ingestion","llm","natural-language-processing","nlp","rag","react","react-native","retrieval-augmented-generation","typescript","web-gpu","web-llm","webgpu","webllm"],"created_at":"2026-04-12T03:34:18.414Z","updated_at":"2026-04-12T03:34:19.136Z","avatar_url":"https://github.com/europanite.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Client Side RAG](https://github.com/europanite/client_side_rag \"Client Side RAG\")\n\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n![OS](https://img.shields.io/badge/OS-Linux%20%7C%20macOS%20%7C%20Windows-blue)\n[![CI](https://github.com/europanite/client_side_rag/actions/workflows/ci.yml/badge.svg)](https://github.com/europanite/client_side_rag/actions/workflows/ci.yml)\n[![docker](https://github.com/europanite/client_side_rag/actions/workflows/docker.yml/badge.svg)](https://github.com/europanite/client_side_rag/actions/workflows/docker.yml)\n[![GitHub Pages](https://github.com/europanite/client_side_rag/actions/workflows/deploy-pages.yml/badge.svg)](https://github.com/europanite/client_side_rag/actions/workflows/deploy-pages.yml)\n\n![React Native](https://img.shields.io/badge/react_native-%2320232a.svg?style=for-the-badge\u0026logo=react\u0026logoColor=%2361DAFB)\n![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge\u0026logo=typescript\u0026logoColor=white)\n![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge\u0026logo=jest\u0026logoColor=white)\n![Expo](https://img.shields.io/badge/expo-1C1E24?style=for-the-badge\u0026logo=expo\u0026logoColor=#D04A37)\n\n![\"web_ui\"](./assets/images/web_ui.png)\n\n[PlayGround](https://europanite.github.io/client_side_rag/)\n\nClient-side, browser-based Retrieval-Augmented Generation (RAG) playground.\n\nEverything runs in the browser using Expo / React Native for Web with an optional local LLM powered by WebLLM (WebGPU). No custom backend service is required; the RAG index is served as static JSON. \n\n---\n\n## Features\n\n- ⚡ **Pure client-side RAG**\n  - Retrieval runs entirely in the browser against a static JSON index (`corpus_chunks.json` and optional `corpus_embeddings.json`). \n- 🤖 **Optional local LLM via WebLLM**\n  - If WebGPU is available, the app initializes WebLLM in the browser and uses it to generate answers conditioned on retrieved context.\n  - If initialization fails or WebGPU is missing, the UI switches to a fallback mode and shows only retrieved chunks.\n  - There is no application server: only static hosting. Any API base env vars are for compatibility with other setups.\n\n---\n\n## RAG Data\n\nThe RAG corpus lives under:\n\nfrontend/app/public/rag/corpus_chunks.json\n\noptionally, frontend/app/public/rag/corpus_embeddings.json\n\ncorpus_chunks.json\n\nThis is a JSON array of chunks:\n```json\n[\n  {\n    \"id\": \"doc1\",\n    \"text\": \"This project is a client-side RAG playground. It runs on React Native for Web and GitHub Pages without any backend.\",\n    \"source\": \"README\"\n  },\n  {\n    \"id\": \"doc2\",\n    \"text\": \"RAG stands for Retrieval Augmented Generation. The app retrieves relevant chunks from local JSON files and optionally uses a local LLM.\",\n    \"source\": \"docs\"\n  }\n]\n```\n\n---\n\n## 🚀 Getting Started\n\n### 1. Prerequisites\n- [Docker Compose](https://docs.docker.com/compose/)\n\n### 2. Build and start all services:\n\n```bash\n# set environment variables:\nexport REACT_NATIVE_PACKAGER_HOSTNAME=${YOUR_HOST}\n\n# Build the image\ndocker compose build\n\n# Run the container\ndocker compose up\n```\n\n### 3. Test:\n```bash\ndocker compose \\\n-f docker-compose.test.yml up \\\n--build --exit-code-from \\\nfrontend_test\n```\n\n---\n\n# License\n- Apache License 2.0","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feuropanite%2Fclient_side_rag","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feuropanite%2Fclient_side_rag","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feuropanite%2Fclient_side_rag/lists"}