Doc Update with the missing steps in INSTALL_GUIDE.md #183
Conversation
Updated the missing steps in INSTALL_GUIDE.md to avoid any Setup error
WalkthroughUpdated installation guide: added a new Supabase table-creation step, renumbered subsequent startup steps, revised backend/frontend startup commands, and added FalkorDB and Supabase database description sections; minor wording and ordering adjustments throughout Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
docs/INSTALL_GUIDE.md (3)
57-70: Clarify directory navigation and add error handling context.The Supabase setup instructions reference two different directories without clearly explaining the relative path structure or whether users should return to the project root between steps. Additionally, the instructions should clarify what to do if SQL scripts are missing or the "Table Not Found" error still occurs after setup.
Consider restructuring for clarity:
-# 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. +# 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 ../app/database/supabase/scripts +# Copy and paste the SQL scripts in this folder into the SQL editor as well. + +# Return to project root +cd ../../../../This makes the relative path changes explicit and indicates when users should return to the project root.
88-90: Normalize path notation and clarify Flask command execution.The Windows-style backslash path (
.\backend\app\database\falkor\code-graph-backend\api) is inconsistent with the forward-slash paths used throughout the rest of the guide. Additionally, the Flask command should clarify whether it requires poetry activation or if it assumes the poetry environment is already active.Apply this diff to normalize path notation and add clarity:
-cd .\backend\app\database\falkor\code-graph-backend\api -flask --app index.py run --debug --port 5000 +cd backend/app/database/falkor/code-graph-backend/api +poetry run flask --app index.py run --debug --port 5000Using
poetry runensures consistency with other backend commands and guarantees the command runs within the poetry environment.
181-182: Add setup and startup instructions for FalkorDB section.The FalkorDB section describes its purpose but lacks the concrete setup and startup steps provided for Weaviate and other services. Users will need clear guidance on how to verify FalkorDB is running and how to interact with it.
Expand the FalkorDB section with setup guidance:
### FalkorDB CodeGraph Database -FalkorDB is used to store and query the code graph of repositories, representing files, functions, and their relationships for code analysis. +FalkorDB is used to store and query the code graph of repositories, representing files, functions, and their relationships for code analysis. It runs in Docker as part of the `docker-compose up` command. + +To verify FalkorDB is running: +```sh +docker ps | grep falkordb +``` + +The FalkorDB API runs on port 5000 (see step 8: "Start the backend server").
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/INSTALL_GUIDE.md (1)
83-91: Normalize GraphDB start instructions (path is inconsistent and Windows-only).
Youcd backend(Line 85) and thencd .\backend\...(Line 89), which double-prefixesbackend/and mixes path styles. Recommend a single, repo-root-relative POSIX path (and optionally add a Windows PowerShell equivalent).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 app/database/falkor/code-graph-backend/api flask --app index.py run --debug --port 5000
🧹 Nitpick comments (1)
docs/INSTALL_GUIDE.md (1)
181-186: DB sections look good; consider linking to the exact compose services/env vars.
The new FalkorDB/Supabase descriptions are helpful; adding a pointer to the relevantdocker-composeservice names and the required Supabase env vars here would make this section more actionable.
| 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. | ||
| ``` |
There was a problem hiding this comment.
Fix cd flow in Supabase table setup (current commands likely land in the wrong directory).
After cd backend/database, the next cd backend/app/... will try to resolve inside backend/database. Consider making all paths explicitly “from repo root” (or cd back to root between steps).
-# Step 1: Create integration tables
-cd backend/database
+# 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.🤖 Prompt for AI Agents
In docs/INSTALL_GUIDE.md around lines 57 to 70 the sequence of cd commands can
resolve relative to the previous directory and land in the wrong path; make the
paths explicit from the repository root or add a cd back to repo root between
steps so each step runs from a known location (for example, use absolute
repo-root-relative paths like ./backend/database and
./backend/app/database/supabase/scripts or insert a cd to the repository root
before the second step) to ensure the SQL files are opened from the intended
folders.
| 7. **Set up Docker container** | ||
| ```sh | ||
| cd backend | ||
| docker-compose up -d # Start weaviate, falkordb, rabbitmq | ||
| ``` | ||
|
|
||
| 7. **Start Docker containers** | ||
| 8. **Start Docker containers** | ||
| ```sh | ||
| Go to docker dekstop and start the containers | ||
| ``` |
There was a problem hiding this comment.
Typos + wording polish in Docker steps.
Line 80: “docker dekstop” → “Docker Desktop”. Also “Set up Docker container” vs “Start Docker containers” reads inconsistent—consider “Start Docker containers (docker-compose up)” and drop the manual Desktop step (or mark it optional).
🤖 Prompt for AI Agents
In docs/INSTALL_GUIDE.md around lines 72 to 81, fix typos and clarify Docker
steps: rename the section titles to be consistent (e.g., "Start Docker
containers (docker-compose up)"), change the text "docker dekstop" to "Docker
Desktop", and either remove the separate manual Desktop instruction or mark it
explicitly as optional (e.g., "Optional: start containers via Docker Desktop").
Ensure the commands remain unchanged and the wording is concise and consistent.
1 participant
Updated the missing steps in INSTALL_GUIDE.md to avoid any Setup error
Closes #
📝 Description
The INSTALL_GUIDE.md was missing some steps to setup the Supabase Table, proper guide to the flask app path
which raised errors such as 'No Flask app-Found. '
🔧 Changes Made
Added the step to setup the Supabase table.
Added the steps required to reach and run the Flask App
📷 Screenshots or Visual Changes (if applicable)
🤝 Collaboration
NA
Collaborated with:
@username(optional)✅ Checklist
Summary by CodeRabbit
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.