flexible-graphrag

(β˜… 180)

Python, LlamaIndex, LangChain, 15 Property Graph, 4 RDF , 10 Vector, OpenSearch, Elasticsearch, Alfresco, Nuxeo DBs. 14 data sources (10 auto-sync), KG auto-building, Ontologies, LLMs, Docling, LlamaParse, LiteParse, GraphRAG, RAG, Hybrid Search, AI Chat. TypeScript React, Vue, Angular frontends, REST, MCP Server. Options: Langflow, CocoIndex

  • .gitattributes
  • .gitignore
  • CHANGELOG.md
  • LICENSE
  • pytest.ini
  • README.md
  • sample-launch.json
  • zensical.toml

# Installation Guide

1. Get the code
git clone https://github.com/stevereiner/flexible-graphrag

Downloads the entire project code from GitHub to your computer.

cd flexible-graphrag

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
cd docker

Moves into the project folder you just downloaded.

cp docker-env-sample.txt docker.env

Type this command into your terminal and run it.

copy docker-env-sample.txt docker.env

Type this command into your terminal and run it.

docker-compose -f docker-compose.yaml -p flexible-graphrag up -d

Runs the command against the services defined in the compose file.

- includes/app-stack.yaml # Backend and UI in Docker

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm run dev

Starts the development/run server.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
uv pip install -e .

Installs the Python libraries listed in requirements.txt (or similar).

uv pip install --override extras-overrides.txt -e ".[langchain,langchain-extras,age-extras]"

Installs the Python libraries listed in requirements.txt (or similar).

uv pip install -e ".[surrealdb-extras]"

Installs the Python libraries listed in requirements.txt (or similar).

uv pip install "surrealdb>=2.0" "langchain-core>=1.3"

Installs the Python libraries listed in requirements.txt (or similar).

uv pip install flexible-graphrag

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation