.github/FUNDING.yml

@@ -0,0 +1,14 @@
+# These are supported funding model platforms
+
+github: nilsherzig # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: nilsherzig # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: question
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

Dockerfile

@@ -1,18 +1,13 @@
-FROM node:20-alpine3.19 AS builder
+FROM node:alpine as build
+ARG PUBLIC_VERSION="0"
+ENV PUBLIC_VERSION=${PUBLIC_VERSION}
+
+ADD . /app
 WORKDIR /app
-COPY package*.json ./
-RUN npm ci
-COPY . .
+
+RUN npm install
 RUN npm run build
-# RUN npm prune --production
-EXPOSE 4173
-CMD ["npm", "run", "preview", "--", "--host"]
 
-# FROM node:20-alpine3.19
-# WORKDIR /app
-# COPY --from=builder /app/build build/
-# COPY --from=builder /app/node_modules node_modules/
-# COPY package.json .
-# EXPOSE 3000
-# ENV NODE_ENV=production
-# CMD [ "node", "build" ]
+FROM nginx:stable-alpine
+COPY nginx.conf /etc/nginx/conf.d/default.conf
+COPY --from=build /app/build /usr/share/nginx/html

Makefile

@@ -1,7 +1,30 @@
-DOCKER_HUB_USER ?= nilsherzig
-BACKEND_NAME ?= llocalsearch-backend
-FRONTEND_NAME ?= llocalsearch-frontend
-GIT_HASH := $(shell git rev-parse --short HEAD)
+#TODO use this as a version
+GIT_HASH := $(shell git rev-parse --short HEAD) 
+
+LATEST_TAG := $(shell git describe --tags --abbrev=0)
+CURRENT_TIMESTAMP := $(shell date +%s)
+
+# used for local testing, so i can save the platform build time
+PHONY: build-containers
+build-containers:
+	(cd ./metrics/ && docker buildx build --build-arg="VERSION=$(CURRENT_TIMESTAMP)" . -t nilsherzig/lsm:latest --load)
+	docker buildx build --build-arg="PUBLIC_VERSION=$(CURRENT_TIMESTAMP)" . -t nilsherzig/llocalsearch-frontend:latest --load
+	(cd ./backend/ && docker buildx build . -t nilsherzig/llocalsearch-backend:latest --load)
+
+# containers which will be published
+PHONY: build-containers-multi
+build-containers-multi:
+	(cd ./metrics/ && docker buildx build --build-arg="VERSION=$(CURRENT_TIMESTAMP)" . -t nilsherzig/lsm:latest --push --platform linux/amd64,linux/arm64)
+	docker buildx build --build-arg="PUBLIC_VERSION=$(CURRENT_TIMESTAMP)" . -t nilsherzig/llocalsearch-frontend:latest --push --platform linux/amd64,linux/arm64
+	(cd ./backend/ && docker buildx build . -t nilsherzig/llocalsearch-backend:latest --push --platform linux/amd64,linux/arm64)
+
+PHONY: new-release
+new-release: build-containers-multi 
+	@echo "New release pushed to Docker Hub"
+
+PHONY: e2e-backend
+e2e-backend:
+	(cd ./backend && ginkgo -v -r ./...)
 
 # dev run commands
 PHONY: build-dev
@@ -10,48 +33,8 @@ build-dev:
 
 PHONY: dev
 dev: build-dev
-	docker-compose -f ./docker-compose.dev.yaml up
+	docker-compose -f ./docker-compose.dev.yaml up $(ARGS)
 
-# normal hosting commands
-PHONY: run
-run: 
-	docker-compose up -d
-
-PHONY: stop
-stop: 
-	docker-compose -f ./docker-compose.dev.yaml down 
-
-PHONY: update
-update:  
-	git pull
-
-PHONY: upgrade
-upgrade: stop update run
-
-# release / docker build commands
-release-stable: build-stable tag-git-hash push
-	@echo "Release stable version with git hash $(GIT_HASH)"
-
-release-latest: build-latest tag-git-hash push
-	@echo "Release latest version with git hash $(GIT_HASH)"
-
-build-latest:
-	docker build -t $(DOCKER_HUB_USER)/$(FRONTEND_NAME):latest .
-	(cd ./backend && docker build -t $(DOCKER_HUB_USER)/$(BACKEND_NAME):latest .)
-
-build-stable:
-	docker build -t $(DOCKER_HUB_USER)/$(FRONTEND_NAME):stable .
-	(cd ./backend && docker build -t $(DOCKER_HUB_USER)/$(BACKEND_NAME):stable .)
-
-tag-git-hash:
-	docker tag $(DOCKER_HUB_USER)/$(BACKEND_NAME):latest $(DOCKER_HUB_USER)/$(BACKEND_NAME):$(GIT_HASH)
-	docker tag $(DOCKER_HUB_USER)/$(FRONTEND_NAME):latest $(DOCKER_HUB_USER)/$(FRONTEND_NAME):$(GIT_HASH)
-
-push:
-	@echo "Pushing images to Docker Hub"
-	# docker push $(DOCKER_HUB_USER)$/$(BACKEND_NAME):$(GIT_HASH)
-	# docker push $(DOCKER_HUB_USER)$/$(FRONTEND_NAME):$(GIT_HASH)
-	# docker push $(DOCKER_HUB_USER)$/$(BACKEND_NAME):latest
-	# docker push $(DOCKER_HUB_USER)$/$(FRONTEND_NAME):latest
-	docker push $(DOCKER_HUB_USER)/$(BACKEND_NAME):stable
-	docker push $(DOCKER_HUB_USER)/$(FRONTEND_NAME):stable
+PHONY: dev-bg
+dev-bg: build-dev
+	docker-compose -f ./docker-compose.dev.yaml up -d

OLLAMA_GUIDE.md

@@ -0,0 +1,46 @@
+# Instructions on how to get LLocalSearch working with your Ollama instance
+
+<!--toc:start-->
+- [Instructions on how to get LLocalSearch working with your Ollama instance](#instructions-on-how-to-get-llocalsearch-working-with-your-ollama-instance)
+  - [You're running Ollama on your host machine (without docker)](#youre-running-ollama-on-your-host-machine-without-docker)
+    - [You're using Linux or macOS](#youre-using-linux-or-macos)
+    - [You're using Windows](#youre-using-windows)
+  - [You're running Ollama in a docker container on the same machine as LLocalSearch](#youre-running-ollama-in-a-docker-container-on-the-same-machine-as-llocalsearch)
+  - [You're running Ollama on a Server or different machine](#youre-running-ollama-on-a-server-or-different-machine)
+<!--toc:end-->
+
+## You're running Ollama on your host machine (without docker)
+
+### You're using Linux or macOS
+
+1. Make sure Ollama is listening on all interfaces (`0.0.0.0`, or at least the docker network).
+2. Add the following to the `.env` file (create one if it doesn't exist) in the root of the project:
+
+```yaml
+OLLAMA_HOST=host.docker.internal:11434
+```
+
+> [!WARNING]
+> Some linux users reported that this solution requires docker desktop to be installed. Please report back if that's the case for you. I don't have this issue on NixOS or my Ubuntu 22.04 test box.
+
+### You're using Windows
+
+Try the above and tell me if it worked, I will update these docs.
+
+## You're running Ollama in a docker container on the same machine as LLocalSearch 
+
+1. Make sure your exposing Ollama on port 11434.
+2. Add the following to the `.env` file (create one if it doesn't exist) in the root of the project:
+
+```yaml
+OLLAMA_HOST=host.docker.internal:11434
+```
+
+## You're running Ollama on a Server or different machine
+
+1. Make sure Ollama is reachable from the container.
+2. Add the following to the `.env` file (create one if it doesn't exist) in the root of the project:
+
+```yaml
+OLLAMA_HOST=ollama-server-ip:11434
+```

README.md

@@ -1,70 +1,79 @@
 # LLocalSearch
 
-## What it is
+## What it is and what it does
 
-This is a completely locally running search engine using LLM Agents. The user can ask a question and the system will use a chain of LLMs to find the answer. The user can see the progress of the agents and the final answer. No OpenAI or Google API keys are needed.
+LLocalSearch is a wrapper around locally running `Large Language Models` (like ChatGTP, but a lot smaller and less "smart") which allows them to choose from a set of tools. These tools allow them to search the internet for current information about your question. This process is recursive, which means, that the running LLM can freely choose to use tools (even multiple times) based on the information its getting from you and other tool calls. 
 
-Now with follow-up questions: 
+[demo.webm](https://github.com/nilsherzig/LLocalSearch/assets/72463901/e13e2531-05a8-40af-8551-965ed9d24eb4)
 
-https://github.com/nilsherzig/LLocalSearch/assets/72463901/8323be25-de2a-4ddf-853b-4a01557b5599
+### Why would I want to use this and not something from `xy`?
 
+The long term plan, which OpenAI is [selling](https://www.adweek.com/media/openai-preferred-publisher-program-deck/) to big media houses:
 
-![image](https://github.com/nilsherzig/LLocalSearch/assets/72463901/9f6497aa-8047-4d11-9a12-66aff65d3faa)
+> Additionally, members of the program receive priority placement and “richer brand expression” in chat conversations, and their content benefits from more prominent link treatments. 
 
-## Features 
+If you dislike the idea of getting manipulated by the highest bidder, you might want to try some less discriminatory alternatives, like this project. 
 
--  🕵️ Completely local (no need for API keys)
-- 💸 Runs on "low end" LLM Hardware (demo video uses a 7b model)
-- 🤓 Progress logs, allowing for a better understanding of the search process
-- 🤔 Follow-up questions
-- 📱 Mobile friendly interface
-- 🚀 Fast and easy to deploy with Docker Compose
-- 🌐 Web interface, allowing for easy access from any device
-- 💮 Handcrafted UI with light and dark mode
+### Features
 
-## Status 
+- 🕵‍♀ Completely local (no need for API keys) and thus a lot more privacy respecting
+- 💸 Runs on "low end" hardware (the demo video uses a 300€ GPU)
+- 🤓 Live logs and links in the answer allow you do get a better understanding about what the agent is doing and what information the answer is based on. Allowing for a great starting point to dive deeper into your research.
+- 🤔 Supports follow up questions
+- 📱 Mobile friendly design
+- 🌓 Dark and light mode
 
-This project is still in its very early days. Expect some bugs. 
 
-## How it works 
+## Road-map
 
-Please read [infra](https://github.com/nilsherzig/LLocalSearch/issues/17) to get the most up-to-date idea.
+### I'm currently working on 👷
 
-## Self-hosting & Development
+#### Support for LLama3 🦙
 
-### Requirements
+The langchain library im using does not respect the LLama3 stop words, which results in LLama3 starting to hallucinate at the end of a turn. I have a working patch (checkout the experiments branch), but since im unsure if my way is the right way to solve this, im still waiting for a response from the  [langchaingo](https://github.com/tmc/langchaingo) team.
 
-- A running [Ollama](https://ollama.com/) server, reachable from the container
-    - GPU is not needed, but recommended
-- Docker Compose
+#### Interface overhaul 🌟
 
-### Run the latest release
+An Interface overhaul, allowing for more flexible panels and more efficient use of space. 
+Inspired by the current layout of [Obsidian](https://obsidian.md)
 
-Recommended, if you don't intend to develop on this project.
+#### Support for chat histories / recent conversations 🕵‍♀
 
-```bash
-git clone https://github.com/nilsherzig/LLocalSearch.git
-cd ./LLocalSearch
-# 🔴 check the env vars inside the compose file and add your ollama servers host:port
-docker-compose up 
-```
+Still needs a lot of work, like refactoring a lot of the internal data structures to allow for more better and more flexible ways to expand the functionality in the future without having to rewrite the whole data transmission and interface part again.
+
+
+### Planned (near future)
+
+#### User Accounts 🙆
+
+Groundwork for private information inside the rag chain, like uploading your own documents, or connecting LLocalSearch to services like Google Drive, or Confluence.
+
+#### Long term memory 🧠
 
-🎉 You should now be able to open the web interface on http://localhost:3000. Nothing else is exposed by default.
+Not sure if there is a right way to implement this, but provide the main agent chain with information about the user, like preferences and having an extra Vector DB Namespace per user for persistent information.
 
-### Run the current git version 
+## Install Guide
 
-Newer features, but potentially less stable.
+### Docker 🐳
+
+1. Clone the GitHub Repository
 
 ```bash
-git clone https://github.com/nilsherzig/LLocalsearch.git
-# 1. make sure to check the env vars inside the `docker-compose.dev.yaml`.
-# 2. Make sure you've really checked the dev compose file not the normal one.
+git@github.com:nilsherzig/LLocalSearch.git
+cd LLocalSearch
+```
 
-# 3. build the containers and start the services
-make dev 
-# Both front and backend will hot reload on code changes. 
+2. Create and edit an `.env` file, if you need to change some of the default settings. This is typically only needed if you have Ollama running on a different device or if you want to build a more complex setup (for more than your personal use f.ex.). Please read [Ollama Setup Guide](./Ollama_Guide.md) if you struggle to get the Ollama connection running.
+
+```bash
+touch .env
+code .env # open file with vscode
+nvim .env # open file with neovim
 ```
 
-If you don't have `make` installed, you can run the commands inside the Makefile manually.
+3. Run the containers
+
+```bash
+docker-compose up -d
+```
 
-Now you should be able to access the frontend on [http://localhost:3000](http://localhost:3000).