initial commit

Author: Kaltsoon

.dockerignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+data

.env.template

@@ -0,0 +1,8 @@
+POSTGRES_HOST=pg
+POSTGRES_PORT=5432
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_DB=postgres
+REDIS_URL=redis://redis:6379
+OLLAMA_URL=http://host.docker.internal:11434
+OLLAMA_MODEL=llama3

.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Compile TypeScript
+        run: npx tsc --noEmit

.gitignore

@@ -0,0 +1,4 @@
+dist
+node_modules
+.env
+data

Dockerfile

@@ -0,0 +1,13 @@
+FROM node:20
+
+WORKDIR /app
+
+COPY package*.json ./
+
+RUN npm install
+
+COPY . .
+
+RUN npm run build
+
+ENTRYPOINT ["npm", "run", "start"]

README.md

@@ -0,0 +1,18 @@
+# 📚 RAG My Docs
+
+[![Test](https://github.com/Kaltsoon/rag-my-docs/actions/workflows/test.yml/badge.svg)](https://github.com/Kaltsoon/rag-my-docs/actions/workflows/test.yml)
+
+A CLI application for building a [RAG](https://blogs.nvidia.com/blog/what-is-retrieval-augmented-generation/) for GitHub repository's markdown files and using it as a context for an LLM to ask questions related to the repository's documentation.
+
+The client code is implemented using TypeScript. PostgreSQL with [pgvector](https://github.com/pgvector/pgvector) is used as a vector database. Redis is used for caching purposes.
+
+## Requirements
+
+Docker and [Ollama](https://ollama.com/).
+
+## How to use?
+
+1. Setup [Ollama](https://ollama.com/) and pull the `llama3:8b` model by running `ollama pull llama3:8b`. You can use other Ollama models as well, see next step for configuration instructions.
+2. Create a `.env` and with the contents of the `.env.template` file. Feel free to change the environment variables, e.g. `OLLAMA_MODEL` variable to change the model.
+2. Run the containers by running `docker compose up -d pg redis`.
+3. Once the containers are ready, run the CLI application by running `docker compose run -it --rm cli` and follow the instructions provided by the application.

compose.yml

@@ -0,0 +1,24 @@
+services:
+  cli:
+    build:
+      context: ./
+    env_file: .env
+    container_name: rag-my-docs-cli
+  redis:
+    image: redis/redis-stack-server
+    volumes:
+      - redis_data:/data
+    container_name: rag-my-docs-redis
+  pg:
+    image: pgvector/pgvector:pg16
+    restart: always
+    environment:
+      - PGDATA=/data
+      - POSTGRES_PASSWORD=postgres
+    volumes:
+      - pg_data:/data
+    container_name: rag-my-docs-postgres
+volumes:
+  redis_data:
+  ollama_data:
+  pg_data: