Skip to content

updated docs and added setup video guide #152

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

Merged
merged 2 commits into from
Oct 27, 2025
Merged

updated docs and added setup video guide #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fe2188
updated docs and added setup video guide
DhruvK278 Oct 27, 2025
da4a130
logo bg remove
DhruvK278 Oct 27, 2025
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
0 assets/images/DevrAI.svg → DevrAI.svg
View file
Open in desktop
File renamed without changes
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">
<span>
<img src="[TO BE FILLED - DevR.AI LOGO]" alt="Devr.AI logo" width="150" height="auto" />
<img src="assets\images\Devr logo.png" alt="Devr.AI logo" width="150" height="auto" />
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Use forward slashes in asset paths for cross-platform compatibility.

The logo path uses a Windows-only backslash separator. Replace with forward slashes so the path works on Linux, macOS, and Windows.

-<img src="assets\images\Devr logo.png" alt="Devr.AI logo" width="150" height="auto" />
+<img src="assets/images/Devr logo.png" alt="Devr.AI logo" width="150" height="auto" />
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<img src="assets\images\Devr logo.png" alt="Devr.AI logo" width="150" height="auto" />
<img src="assets/images/Devr logo.png" alt="Devr.AI logo" width="150" height="auto" />
🤖 Prompt for AI Agents 
In README.md around line 3, the image src uses Windows backslashes
("assets\images\Devr logo.png"); replace them with forward slashes
("assets/images/Devr logo.png") to ensure cross-platform compatibility, then
save and verify the image renders correctly (and adjust the path if the file is
in a different relative location).

</span>

# 🤖 Devr.AI - AI-Powered Developer Relations Assistant
Expand Down Expand Up @@ -91,10 +91,10 @@ For detailed setup instructions, troubleshooting, and deployment guides, please

## 🎯 Bot Commands

- `!verify_github` - Link your GitHub account for enhanced personalization
- `!verification_status` - Check your GitHub account linking status
- `!reset` - Clear conversation memory and start fresh
- `!help_devrel` - Display available commands and bot capabilities
- `/verify_github` - Link your GitHub account for enhanced personalization
- `/verification_status` - Check your GitHub account linking status
- `/reset` - Clear conversation memory and start fresh
- `/help_devrel` - Display available commands and bot capabilities

<!-- TODO -->
<!-- ## 🎬 Feature Showcase
Expand Down
Binary file added assets/images/Devr logo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 28 additions & 14 deletions backend/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,41 @@
# PORT=8000
# CORS_ORIGINS=http://localhost:3000

SUPABASE_URL=
SUPABASE_SERVICE_ROLE_KEY=
SUPABASE_URL="https://.supabase.co"
SUPABASE_KEY="ey...cnGQk"

DISCORD_BOT_TOKEN=
# ENABLE_DISCORD_BOT=true
DISCORD_BOT_TOKEN="MTM5...5Vr7fw0m9PGAllLfyztCs"
ENABLE_DISCORD_BOT="true"

GITHUB_TOKEN=
# Add Org Name here
GITHUB_ORG=
GITHUB_TOKEN="ghp_...3IOhGP970vnjYK"

# EMBEDDING_MODEL=BAAI/bge-small-en-v1.5
# EMBEDDING_MAX_BATCH_SIZE=32
# EMBEDDING_DEVICE=cpu

BACKEND_URL=
# FalkorDB Configuration
FALKORDB_HOST=localhost
FALKORDB_PORT=6379
CODEGRAPH_BACKEND_URL=http://localhost:5000
CODEGRAPH_SECRET_TOKEN=DevRAI_CodeGraph_Secret
GEMINI_MODEL=gemini-2.0-flash
SECRET_TOKEN=DevRAI_CodeGraph_Secret
CODE_GRAPH_PUBLIC=1
FLASK_RUN_HOST=0.0.0.0
FLASK_RUN_PORT=5000

GEMINI_API_KEY=
TAVILY_API_KEY=
BACKEND_URL="http://localhost:8000"

GEMINI_API_KEY="AIz...ct527D5h-IJCRaXE"
TAVILY_API_KEY="tvly-dev-....1G2k3ivF56SJfWJ4"

# Langsmith
LANGSMITH_TRACING=
LANGSMITH_ENDPOINT=
LANGSMITH_API_KEY=
LANGSMITH_PROJECT=
LANGSMITH_TRACING="true"
LANGSMITH_ENDPOINT="https://api.smith.langchain.com"
LANGSMITH_API_KEY="lsv2_pt...d9d989_953d073741"
LANGSMITH_PROJECT="devr"

ORG_NAME=AOSSIE
ORG_WEBSITE=https://aossie.org
ORG_GITHUB=https://github.com/AOSSIE-Org
ORG_TWITTER=https://x.com/aossie_org
18 changes: 13 additions & 5 deletions docs/INSTALL_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Devr.AI Installation Guide

Follow this guide to set up Devr.AI's development environment on your local machine.
For Setup guide video tutorial go to [Devr Setup Guide](https://drive.google.com/file/d/1vlwGE5oJrbXb1gkZJv2NT2rHyt-z-RDv/view?usp=sharing)

## Prerequisites

Expand Down Expand Up @@ -54,19 +55,26 @@ cp env.example .env
nano .env # or use your preferred editor
```

6. **Start Weaviate database**
6. **Set up Docker container**
```sh
cd backend
docker-compose up -d weaviate
docker-compose up -d # Start weaviate, falkordb, rabbitmq
```

7. **Start Docker containers**
```sh
Go to docker dekstop and start the containers
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix typo: "dekstop" → "desktop".

-Go to docker dekstop and start the containers
+Go to Docker Desktop and start the containers
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Go to docker dekstop and start the containers
Go to Docker Desktop and start the containers
🤖 Prompt for AI Agents 
In docs/INSTALL_GUIDE.md around line 66, fix the typo "dekstop" to "desktop" in
the sentence "Go to docker dekstop and start the containers" by updating the
word to "desktop" so it reads "Go to Docker Desktop and start the containers"
(also consider capitalizing Docker Desktop for clarity).

```

7. **Start the backend server**
8. **Start the backend server**
```sh
cd backend
poetry run python main.py
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)
```

8. **Start the frontend** (in a new terminal)
9. **Start the frontend** (in a new terminal)
```sh
cd frontend
npm install
Expand Down
62 changes: 8 additions & 54 deletions poetry.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ dependencies = [
"uvicorn (>=0.38.0,<0.39.0)",
"ddgs (>=9.0.2,<10.0.0)",
"fastmcp>=2.11.3,<3.0.0",
"discord-py (>=2.6.4,<3.0.0)",
"discord-py (>=2.4.0,<2.5.0)",
"graphrag-sdk (>=0.8.1,<0.9.0)",
"tree-sitter (>=0.25.2,<0.26.0)",
"validators (>=0.35.0,<0.36.0)",
Expand Down