Skip to content

Doc Update with the missing steps in INSTALL_GUIDE.md #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ishtiyaque-Alam wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Doc Update with the missing steps in INSTALL_GUIDE.md #183

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
510ea12
Doc Update with the missing steps
Ishtiyaque-Alam Dec 13, 2025
dd55eb7
Update installation guide section numbering
Ishtiyaque-Alam Dec 13, 2025
0cff214
Merge branch 'AOSSIE-Org:main' into Ishtiyaque-Alam-Docs-Updating-the…
Ishtiyaque-Alam Jan 4, 2026
b5b35c8
Update installation guide for clarity and path adjustments
Ishtiyaque-Alam Jan 4, 2026
659645c
Revise Docker setup instructions in INSTALL_GUIDE.md
Ishtiyaque-Alam Jan 4, 2026
510c4a2
Minor change to repo location
Ishtiyaque-Alam Jan 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 27 additions & 8 deletions docs/INSTALL_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,27 +54,44 @@ 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 (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.

6. **Set up Docker container**
# 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.
```

7. **Start Docker containers**
```sh
#from repo root
cd backend
docker-compose up -d # Start weaviate, falkordb, rabbitmq
```

7. **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.
```

8. **Start the backend server**
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)
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)
10. **Start the frontend** (in a new terminal)
```sh
cd frontend
npm install
Expand Down Expand Up @@ -160,9 +177,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.

Expand Down