Skip to content

Docs: Added missing setup instructions for Python Chatbot. #217

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
jayeshpatil7 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: Added missing setup instructions for Python Chatbot. #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,40 @@ The application will automatically reload when you make changes to the source co
npx hardhat ignition deploy ./ignition/modules/<ContractModule> --network <Network> --verify
```

## Chatbot Backend

1. **Navigate to the Chatbot Directory**:

```bash
cd chatbot
```

2. **Create and Activate Virtual Environment**:

**For Windows**
```bash
python -m venv venv
source venv/Scripts/activate
```
Comment on lines +116 to +120
Copy link

@coderabbitai coderabbitai bot Jan 5, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Fix Windows virtual environment activation command.

The Windows activation command uses Unix syntax which will fail on Windows systems. Windows uses backslash paths and requires either batch or PowerShell syntax, not the source command.

🔎 Proposed fix for Windows venv activation 
  **For Windows**
  ```bash
-  python -m venv venv
-  source venv/Scripts/activate
+  python -m venv venv
+  venv\Scripts\activate.bat

**Alternative for PowerShell:**
```bash
venv\Scripts\Activate.ps1
📝 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
**For Windows**
```bash
python -m venv venv
source venv/Scripts/activate
```
**For Windows**
🤖 Prompt for AI Agents 
In @README.md around lines 116-120, Update the Windows venv activation
instructions in the README: replace the Unix-style command "source
venv/Scripts/activate" with the correct Windows batch activation
"venv\Scripts\activate.bat" and optionally document the PowerShell alternative
"venv\Scripts\Activate.ps1" so Windows users have the proper commands.


**For Mac/Linux**:
```bash
python3 -m venv venv
source venv/bin/activate
```

3. **Install Dependencies**:

```bash
pip install -r requirements.txt
```

4. **Run the Application**:

```bash
python app.py
```
Comment on lines +106 to +138
Copy link

@coderabbitai coderabbitai bot Jan 5, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# First, check the structure of the repository
git ls-files | head -20

Repository: AOSSIE-Org/Agora-Blockchain

Length of output: 931

🏁 Script executed:

# Read the full README.md to see all content
wc -l README.md

Repository: AOSSIE-Org/Agora-Blockchain

Length of output: 84

🏁 Script executed:

# Read the entire README to check for troubleshooting sections
cat -n README.md

Repository: AOSSIE-Org/Agora-Blockchain

Length of output: 10502

🏁 Script executed:

# Check the PR template to understand structure
cat -n .github/PULL_REQUEST_TEMPLATE.md

Repository: AOSSIE-Org/Agora-Blockchain

Length of output: 790

🏁 Script executed:

# Search for any troubleshooting content in the entire repo
rg -i "troubleshooting|python.*path|windows.*python" --max-count=20

Repository: AOSSIE-Org/Agora-Blockchain

Length of output: 442

Fix the Windows Python activation command and add the missing troubleshooting note.

The troubleshooting note for Windows Python path issues is missing from the README. Additionally, the Windows activation command on line 119 is incorrect—it uses source venv/Scripts/activate (a Linux/Mac command), but Windows should use venv\Scripts\activate. Either add the troubleshooting note and correct the activation command, or update the PR description to reflect what was actually changed.

🤖 Prompt for AI Agents 
In @README.md around lines 106-138, The Windows activation command in the
Chatbot Backend section is wrong and a troubleshooting note is missing: replace
the Linux/Mac-style "source venv/Scripts/activate" with the correct Windows
activation command "venv\\Scripts\\activate" in the README, and add a short
troubleshooting note advising Windows users to ensure Python is on their PATH
(or to use the "py" launcher/explicit python -m venv invocation) and to run the
activate command from the project directory if activation fails.


## Frontend

1. **Navigate to the Client Directory**:
Expand Down