Viewing File: /home/ubuntu/codegamaai-test/broker_bot/readme.md

# Installation Guide for BrokerBot

This document provides a step-by-step guide to installing and running the BrokerBot Python project. Follow the instructions carefully to set up the project correctly.

## Prerequisites

Before you begin, ensure you have the following installed on your system:

- Python 3.7 or higher
- Git

## Steps to Install and Run BrokerBot

### 1. Clone the Bitbucket Repository

Clone the repository from Bitbucket to your local machine using the following command:

```bash

git clone git@bitbucket.org:codegama/broker_bot.git

```

### 2. Create and Activate Python Environment

Navigate to the project directory and create a Python virtual environment:

```bash

cd <project_directory>
python3 -m venv venv_brokerbot

```

Activate the virtual environment:

- On macOS and Linux:

```bash

    source venv_brokerbot/bin/activate
	
```

### 3. Install Dependencies

Install the required Python packages specified in the requirements.txt file:

```bash

pip3 install -r requirements.txt

```

### 4. Download and Place the Intent Classification Model

Download the Intent Classification Model from the following link:

https://www.dropbox.com/scl/fo/b1aej603g432zndt0q2kd/AE4BdCO_slMj8ks2YaQnY9M?rlkey=iqb9tf8p0rjiyfyxbtahytw4y&st=nsnafcv4&dl=0

After downloading, place the model file in the ./resources folder within your project directory.

### 5. Run the Application

Finally, run the application using the following command:

```bash

python3 app.py

```

- Note: The port specified for this API is 5006.
Back to Directory File Manager