Delphic

(β˜… 317)

Starter App to Build Your Own App to Query Doc Collections with Large Language Models (LLMs) using LlamaIndex, Langchain, OpenAI and more (MIT Licensed)

  • .dockerignore
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .pre-commit-config.yaml
  • .pylintrc
  • CONTRIBUTORS.txt
  • LICENSE
  • local.yml
  • manage.py
  • merge_production_dotenvs_in_dotenv.py
  • production.yml
  • pytest.ini
  • README.md
  • setup.cfg
  • test.yml
  • test_file.txt

# Installation Guide

1. Get the code
git clone https://github.com/JSv4/Delphic

Downloads the entire project code from GitHub to your computer.

cd Delphic

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.
sudo docker-compose --profile fullstack -f local.yml build

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

sudo docker-compose --profile fullstack -f local.yml up

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

sudo docker-compose -f local.yml run django python manage.py createsuperuser

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

sudo docker-compose -f local.yml run django python manage.py test

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

sudo docker-compose -f local.yml up

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

βœ… 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 yarn

Downloads and installs the libraries listed in package.json.

yarn install

Downloads and installs the libraries listed in package.json.

βœ… 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.
pip install -r ./requirements/local.txt

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