Setup Instructions¶

Get the Demo Code¶

Option A: Clone with Git (Recommended):

git clone https://github.com/IBM/beeai-workshop.git

Option B: Download ZIP:

If you're not comfortable with Git, download the ZIP file and extract it to your desired location.

Navigate to the demo folder¶

Navigate to the specific demo folder:

cd beeai-workshop/intro_beeai_platform

Important:
Make sure to open the specific intro_beeai_platform folder, not the entire beeai-workshop directory.
This ensures proper project structure and dependencies are detected.

Set Up Environment Variables¶

Create a .env file based on the existing env.template at the intro_beeai_platform directory level.

cp env.template .env

In your new .env file:

Review the settings
Optionally, add your OpenAI key

Install Project Dependencies¶

Use uv to install the required version of python:
```
uv python install 3.13
```
Install all required dependencies:
```
uv sync
```

This ensures you have the correct versions of all packages used in the demo, installed in the correct environment.