---
title: SalesIQ
emoji: 👁
colorFrom: pink
colorTo: blue
sdk: docker
pinned: false
license: mit
port: 8000
short_description: SalesIQ 
---

## Description
SalesIQ, formerly SalesBuddy

## Prerequisites
- Python 3.11
- node 20.11.0
- pip

## Steps to Setup and Run the Project Locally

### 1. Clone the Remote Repository Locally

Assuming that you are in the directory where you want to clone the repository (`project-directory`), run the following command to clone the repository locally:
```bash
git clone git@github.com:aithon-ai/SalesBuddy.git .
cd <project-directory>
```

### 2. Create a Virtual Environment

Create a virtual environment with python 3.11 for compatibility.

If not familiar with creating virtual environments, follow the steps below:
```bash
python3.11 -m venv venv
source venv/bin/activate # For Linux
venv\Scripts\activate # For Windows 
```

### 3. Install Required Libraries
```bash
pip install -r requirements.txt
```

### 4. Add your API Keys to the `.env` file
Copy the .env.sample file to .env and add your API keys to the file.


## Local Development

We recommend using node version 20.11.0 and pnpm version 9.1.0.

Go to the frontend directory and install the dependencies:

```bash
cd frontend
pnpm install
```

You must build the frontend before running the application:
```bash
cd frontend
pnpm run build
```

To run the application locally, at the main folder, run the following command in the terminal:
```bash
./run.sh
```

The application will be available at http://localhost:8000