From 510ea129d6cd80d1455db71893eb69c89a81993a Mon Sep 17 00:00:00 2001 From: Ishtiyaque-Alam <154577460+Ishtiyaque-Alam@users.noreply.github.com> Date: Sat, 13 Dec 2025 15:38:17 +0530 Subject: [PATCH 1/5] Doc Update with the missing steps Updated the missing steps in INSTALL_GUIDE.md to avoid any Setup error --- docs/INSTALL_GUIDE.md | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/INSTALL_GUIDE.md b/docs/INSTALL_GUIDE.md index ec6548a..609c1d2 100644 --- a/docs/INSTALL_GUIDE.md +++ b/docs/INSTALL_GUIDE.md @@ -54,27 +54,43 @@ cp env.example .env # Edit .env with your API keys and configuration nano .env # or use your preferred editor ``` +6. **Create the required Supabase Tables** +```sh +# This can be done using the Supabase CLI or by pasting the SQL scripts directly into the SQL editor in Supabase. +# If you skip this step, you'll likely get a 'Table Not Found' error. + +# Step 1: Create integration tables +cd backend/database +# Open the file 01_create_integration_tables.sql, copy all its contents, +# and paste it into the SQL editor of your Supabase project. + +# Step 2: Create additional tables +cd backend/app/database/supabase/scripts +# Copy and paste the SQL scripts in this folder into the SQL editor as well. +``` -6. **Set up Docker container** +7. **Set up Docker container** ```sh cd backend docker-compose up -d # Start weaviate, falkordb, rabbitmq ``` -7. **Start Docker containers** +9. **Start Docker containers** ```sh Go to docker dekstop and start the containers ``` -8. **Start the backend server** +10. **Start the backend server** ```sh cd backend poetry run python main.py # Terminal 1 poetry run python start_github_mcp_server.py # Terminal 2 (Start MCP server) -flask --app api/index.py run --debug --port 5000 # Terminal 3 (Start graphDB) +# Terminal 3 (Start graphDB) +cd .\backend\app\database\falkor\code-graph-backend\api +flask --app index.py run --debug --port 5000 ``` -9. **Start the frontend** (in a new terminal) +11. **Start the frontend** (in a new terminal) ```sh cd frontend npm install @@ -160,9 +176,11 @@ Weaviate is used for semantic search and embeddings storage. It runs in Docker: cd backend docker-compose up -d weaviate ``` - The database will be available at `http://localhost:8080` +### FalkorDB CodeGraph Database +FalkorDB is used to store and query the code graph of repositories, representing files, functions, and their relationships for code analysis. + ### Supabase Database Supabase provides the PostgreSQL database for user data and authentication. The connection is configured via environment variables. From dd55eb7ed9b90e4466dff809a55b3c97341a2b06 Mon Sep 17 00:00:00 2001 From: Ishtiyaque-Alam <154577460+Ishtiyaque-Alam@users.noreply.github.com> Date: Sat, 13 Dec 2025 15:55:38 +0530 Subject: [PATCH 2/5] Update installation guide section numbering --- docs/INSTALL_GUIDE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/INSTALL_GUIDE.md b/docs/INSTALL_GUIDE.md index 609c1d2..b9f7b23 100644 --- a/docs/INSTALL_GUIDE.md +++ b/docs/INSTALL_GUIDE.md @@ -75,12 +75,12 @@ cd backend docker-compose up -d # Start weaviate, falkordb, rabbitmq ``` -9. **Start Docker containers** +8. **Start Docker containers** ```sh Go to docker dekstop and start the containers ``` -10. **Start the backend server** +9. **Start the backend server** ```sh cd backend poetry run python main.py # Terminal 1 @@ -90,7 +90,7 @@ cd .\backend\app\database\falkor\code-graph-backend\api flask --app index.py run --debug --port 5000 ``` -11. **Start the frontend** (in a new terminal) +10. **Start the frontend** (in a new terminal) ```sh cd frontend npm install From b5b35c88932d152488ff342a1463ef186cda51cb Mon Sep 17 00:00:00 2001 From: Ishtiyaque-Alam <154577460+Ishtiyaque-Alam@users.noreply.github.com> Date: Mon, 5 Jan 2026 02:27:57 +0530 Subject: [PATCH 3/5] Update installation guide for clarity and path adjustments Clarified installation steps by specifying the directory context for creating integration tables and adjusting the path for additional tables. --- docs/INSTALL_GUIDE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/INSTALL_GUIDE.md b/docs/INSTALL_GUIDE.md index dc4629d..5a28d14 100644 --- a/docs/INSTALL_GUIDE.md +++ b/docs/INSTALL_GUIDE.md @@ -59,13 +59,13 @@ nano .env # or use your preferred editor # This can be done using the Supabase CLI or by pasting the SQL scripts directly into the SQL editor in Supabase. # If you skip this step, you'll likely get a 'Table Not Found' error. -# Step 1: Create integration tables +# Step 1: Create integration tables (from repo root) cd backend/database # Open the file 01_create_integration_tables.sql, copy all its contents, # and paste it into the SQL editor of your Supabase project. # Step 2: Create additional tables -cd backend/app/database/supabase/scripts +cd ../../backend/app/database/supabase/scripts # Copy and paste the SQL scripts in this folder into the SQL editor as well. ``` From 659645ca3e398251a45a6d8bc5bc98a94961fb36 Mon Sep 17 00:00:00 2001 From: Ishtiyaque-Alam <154577460+Ishtiyaque-Alam@users.noreply.github.com> Date: Mon, 5 Jan 2026 02:41:33 +0530 Subject: [PATCH 4/5] Revise Docker setup instructions in INSTALL_GUIDE.md Updated installation guide to clarify Docker setup steps and corrected formatting. --- docs/INSTALL_GUIDE.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/INSTALL_GUIDE.md b/docs/INSTALL_GUIDE.md index 5a28d14..a44c1bc 100644 --- a/docs/INSTALL_GUIDE.md +++ b/docs/INSTALL_GUIDE.md @@ -69,24 +69,24 @@ cd ../../backend/app/database/supabase/scripts # Copy and paste the SQL scripts in this folder into the SQL editor as well. ``` -7. **Set up Docker container** +7. **Start Docker containers** ```sh cd backend docker-compose up -d # Start weaviate, falkordb, rabbitmq ``` -8. **Start Docker containers** + +8. **Optional: Start Docker containers via Desktop** ```sh -Go to docker dekstop and start the containers +Alternatively, open Docker Desktop and start the containers manually. ``` - 9. **Start the backend server** ```sh cd backend poetry run python main.py # Terminal 1 poetry run python start_github_mcp_server.py # Terminal 2 (Start MCP server) # Terminal 3 (Start graphDB) -cd .\backend\app\database\falkor\code-graph-backend\api +cd backend/app/database/falkor/code-graph-backend/api flask --app index.py run --debug --port 5000 ``` From 510c4a2afad724932c07d0a5c1e863fe12d5db6f Mon Sep 17 00:00:00 2001 From: Ishtiyaque-Alam <154577460+Ishtiyaque-Alam@users.noreply.github.com> Date: Mon, 5 Jan 2026 03:17:14 +0530 Subject: [PATCH 5/5] Minor change to repo location --- docs/INSTALL_GUIDE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/INSTALL_GUIDE.md b/docs/INSTALL_GUIDE.md index a44c1bc..3e2f0c8 100644 --- a/docs/INSTALL_GUIDE.md +++ b/docs/INSTALL_GUIDE.md @@ -71,6 +71,7 @@ cd ../../backend/app/database/supabase/scripts 7. **Start Docker containers** ```sh +#from repo root cd backend docker-compose up -d # Start weaviate, falkordb, rabbitmq ```