Skip to content

Latest commit

 

History

History
83 lines (60 loc) · 2.13 KB

README.md

File metadata and controls

83 lines (60 loc) · 2.13 KB

Project Setup Guide

Prerequisites

  • Docker: Ensure you have Docker installed and running.
  • Nvidia GPU: Required to run the model.
  • Windows Operating System: The tested environment for this setup.

Setup Instructions

Clone Required Repositories

Run the following commands to clone the necessary repositories:

git clone git@github.com:Kreative-Performative-Individuals/KB.git
git clone git@github.com:Kreative-Performative-Individuals/smart-industrial-database.git
git clone git@github.com:Kreative-Performative-Individuals/data-preprocessing-.git
git clone git@github.com:Kreative-Performative-Individuals/RAG5.git
git clone git@github.com:Kreative-Performative-Individuals/KPI-Engine.git
git clone git@github.com:Kreative-Performative-Individuals/frontend.git

Run Docker Compose

  1. Build and start all services:

    docker compose up --build

  2. Stop all services:

    docker compose down

  3. Rebuild and start again (the first build may take some time):

    docker compose up --build

Test Integration

Ensure that all services communicate properly after the initial setup.

To test the GUI, follow these steps:

  1. Navigate to the frontend folder:

    cd frontend

  2. Build the frontend Docker container:

    docker build -t frontend .

  3. Run the container:

    docker run -d --name frontend -p 3000:3000 frontend

  4. Open your browser and visit http://localhost:3000 to interact with the GUI.

⚠️ Important Notes

  1. Resource-Heavy Components:

    • Comment out configurations related to RAG and Ollama if you don't need the rag since it's heavy both on disk and on computation.
    • Running Ollama requires an Nvidia GPU, and it may not function correctly on Linux, even with proprietary drivers.

  2. Database Initialization:

    • If the database fails to start, rerun the compose command to ensure the initialization script executes properly: 
      docker compose up --build

Happy coding! 🚀