Setup

---

Prerequisites

• An IDE such as VS Code or Cursor
• Python 3.11+
• Node.js and npm
• uv (Python package manager)

---

1. Clone the repo

Workshop Repository

git clone https://github.com/Redislabs-Solution-Architects/redis-iris-workshop.git

cd redis-iris-workshop

2. Install dependencies

macOS / LinuxWindows (PowerShell)

make install

.\workshop.ps1 install

3. Create your environment file

macOS / LinuxWindows (PowerShell)

cp .env.example .env

Copy-Item .env.example .env

4. Create a Free Redis Cloud Account

Go to redis.io/try-free and sign up or log in.

5. Create a Redis Database

1. Click New database and select Try 30 MB for Free.

   

2. Name it (e.g. iris-workshop).

3. Leave everything else as default.
4. Click Create.

6. Get your Redis credentials

After your database is created, click Connect.

Then open Redis SDK clients → select Python (redis-py) → click the view icon to reveal your credentials.

Open your .env file and set your Redis credentials:

REDIS_HOST=<your host>
REDIS_PORT=<your port>
REDIS_PASSWORD=<your password>

7. Set your OpenAI key

Check Announcements to get the API key (you'll need the session code from your instructor), then set it on line 14 of your .env file:

OPENAI_API_KEY=<your key>

8. Set your domain

On line 6 of your .env file, make sure the domain is set to:

DEMO_DOMAIN=retail

9. Start the app

macOS / LinuxWindows (PowerShell)

make dev

.\workshop.ps1 dev

10. Verify

Open localhost:3040 successfully.