Workshop Setup Instructions¶

Get the Workshop 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.

Open the Workshop in VS Code¶

Navigate to the specific workshop folder and open it in VS Code:

cd beeai-workshop/overview_of_beeai
code .

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

Alternatively, you can open VS Code first and use File > Open Folder to navigate to and select the correct folder.

Set Up Environment Variables¶

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

cp env.template .env

In your new .env file:

Review the settings
Optionally, add your OpenAI key

Install Project Dependencies¶

Install all required dependencies:
```
uv sync
```
Activate the virtual environment created by uv:
```
source .venv/bin/activate
```

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