File Manager

Editing File: /home/ubuntu/codegamaai-test/girlfriend_bot/readme.md

# Installation Guide for Girlfriend Bot

This document provides a step-by-step guide to installing and running the Girlfriend Bot. 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 Girlfriend Bot

### 1. Clone the Bitbucket Repository

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

```bash

git clone https://bitbucket.org/codegama/girlfriend_bot.git
```

### 2. Create and Activate Python Environment

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

```bash

cd <project_directory>
python -m venv venv_gfbot

```

Activate the virtual environment:

- On macOS and Linux:

```bash

source venv_gfbot/bin/activate
	
```

### 3. Install Dependencies

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

```bash

pip3 install -r requirements.txt

```

### 4. Run the Application

Finally, run the application using the following command:

```bash

python3 app.py

```

- Note: The port specified for this API is 5007.

Back to Directory File Manager