{"id":13588877,"url":"https://github.com/krishnasism/heissdocs","last_synced_at":"2025-04-08T06:32:57.703Z","repository":{"id":175400842,"uuid":"628021886","full_name":"krishnasism/heissdocs","owner":"krishnasism","description":"This project is no longer maintained","archived":true,"fork":false,"pushed_at":"2024-03-26T21:18:28.000Z","size":557,"stargazers_count":21,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-06T08:43:22.811Z","etag":null,"topics":["ai","documents","llm","pdf","search"],"latest_commit_sha":null,"homepage":"","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/krishnasism.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2023-04-14T18:14:49.000Z","updated_at":"2024-03-26T21:18:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"9dc10f75-738b-43dc-94fb-93a921ee6b94","html_url":"https://github.com/krishnasism/heissdocs","commit_stats":null,"previous_names":["krishnasism/pdf-search","krishnasism/heissdocs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krishnasism%2Fheissdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krishnasism%2Fheissdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krishnasism%2Fheissdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krishnasism%2Fheissdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/krishnasism","download_url":"https://codeload.github.com/krishnasism/heissdocs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247792221,"owners_count":20996879,"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","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":["ai","documents","llm","pdf","search"],"created_at":"2024-08-01T15:07:00.072Z","updated_at":"2025-04-08T06:32:52.690Z","avatar_url":"https://github.com/krishnasism.png","language":"Vue","funding_links":[],"categories":["Vue"],"sub_categories":[],"readme":"### Note: This project is not maintained anymore\n\n**heißdocs** - A Document Query Application 🔍📄\n\n[Official Documentation](https://docs.heissdocs.com/)\n## # Under Active Development # ##\n\nAdd a searchable layer on top of your PDFs!\n\nFully open-source and ready to be deployed.\nYou store, own, and control the data.\n\n\u003ca href=\"https://www.producthunt.com/posts/heissdocs?utm_source=badge-featured\u0026utm_medium=badge\u0026utm_souce=badge-heissdocs\" target=\"_blank\"\u003e\u003cimg src=\"https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=411357\u0026theme=light\" alt=\"hei\u0026#0223;docs - Open\u0026#0032;Source\u0026#0032;\u0026#0038;\u0026#0032;Self\u0026#0032;Hosted\u0026#0032;Document\u0026#0032;Query\u0026#0032;Engine | Product Hunt\" style=\"width: 250px; height: 54px;\" width=\"250\" height=\"54\" /\u003e\u003c/a\u003e\n\nDemo:\n![Recording-2023-08-26-211554](https://github.com/krishnasism/heissdocs/assets/21293324/680286c6-2c0d-4230-8397-571b4085fd69)\n\n### Note:\n\u003e This is a project in progress, so please expect things to break as it moves forward.\nBut the vision of this project is to allow the user to NOT be locked into an ecosystem, so your data is governed and stored by you - therefore even if the app breaks, your data should be supported and can be accessed using tools already at your disposal.\n\n# Usage\n## What is the purpose of this project?\n\nIt is to allow a user or an organization to keep track of their PDF files. The complicated thing about PDFs is that they aren't searchable by content.\nSimply upload a scanned or normal PDF and start searching for content in it with the undisputed power of Elasticsearch (or a NoSQL database)!\n\n**heißdocs** creates a search layer for your PDFs, down to the exact page (Working on pointing to the exact word!),\n\n1. Set up according to the instructions under `Setup`\n1. Upload a file on the Dashboard\n1. Start searching!\n\n# Features\n- ☁️ Multi-cloud support (AWS, GCP, Azure)\n- 💬 Semantic search (Langchain + OpenAI)\n- 💿 Multiple Storage Options\n- 🔍 Powerful Search + Versatile Storage\n- 📄 View source documents\n- 🔒 Full ownership of data\n- 🆓 Completely open-source\n- 💻 Self-hosted\n- ... more things to come + feel free to add in requests!\n\n\n---\n# Setup\n## Pre-requisites\nPlease set up the required services before starting the application.\nYou can follow [the documentation](https://docs.heissdocs.com/) to configure all services.\n1. Auth0 - required even before startup:\n    1. For Auth0 you will need to get the required values from the [Auth0 portal](https://manage.auth0.com/) and paste them accordingly in the `.env` files in `frontend` and `app`. This needs to be configured even before building the application.\n\n## Setting up\nStart by creating a `.env` file in the root directory and fill in the values according to the `.env.example` file.\n\nBefore startup, only the Auth0 values need to be set up.\nPlease follow the [documentation](https://docs.heissdocs.com/) for the full guide.\n\n```bash\ncp .env.example .env\n```\n\nThe values in the root `.env` file can remain unchanged unless you are planning on hosting each of the services individually.\n\n\nSimilarly, create a `.env` file inside the `app`, `frontend`, and `engine` folders and fill them in following the instructions in the respective `.env.example` files. \n\n```bash\ncp frontend/.env.example frontend/.env\ncp app/.env.example app/.env\ncp engine/.env.example engine/.env\n```\n\nAll the keys except Auth0 keys, can be left untouched. \nEverything else is settable in settings.\n\n---\n\n## Running\nEnsure that the credentials that you pasted in the `.env` files have the necessary authorizations for operations such as `GET`, `PUT`, `LIST` ... etc.\n\nOnce your `.env` files are ready, navigate to the root directory and run:\n```bash\ndocker compose up --build\n```\n\nThen go to `localhost:8080` and log in.\n\n---\n[Optional]\n*In case you want hot-reload on your `frontend`, you can choose to run the services separately*\n\nRun the `backend` services:\n```bash\ndocker compose -f docker-compose.yaml up --build\n```\n\nIf you want elasticsearch locally running as well, you can include the `docker-compose.elasticsearch.override.yaml` file as well in the `docker compose` command.\n\n```bash\ndocker compose -f docker-compose.yaml -f docker-compose.elasticsearch.override.yaml up --build\n```\n\nRun the `frontend`:\n```bash\ncd frontend\nnpm install\nnpm run dev -- --port 8080\n```\n\n##  Run database migrations\n```bash\ncd app\nalembic upgrade head\n```\n\n[Optional] If you have your own hosted PostgresSQL database, please make sure to update the `sqlalchemy.url` in the `alembic.ini` file.\n\n## Settings\nBefore using the application, navigate to the `Settings` page by clicking on the left-side dashboard button, and configure the settings.\n\n## Ready!\nYou are all set!\n\n## Overview\nHere's a quick overview of the project\n\nIngestion Flow\n![Technical Diagrams - Frame 1](https://github.com/krishnasism/heissdocs/assets/21293324/2b34c722-8766-45f3-a5ef-0da343631aa1)\n\nQuery Flow\n![Technical Diagrams - Frame 2](https://github.com/krishnasism/heissdocs/assets/21293324/8a8a8f57-62b3-4e55-9e65-f1cb6882d464)\n\n\n---\nIn progress for the community - by [Krishnasis](https://www.linkedin.com/in/krishnasis/) 👨🏽‍💻\n\nPowered by [FastAPI](https://fastapi.tiangolo.com/) 💗\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkrishnasism%2Fheissdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkrishnasism%2Fheissdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkrishnasism%2Fheissdocs/lists"}