From 879f3d381853efc9da93926669fb82a73209ed8a Mon Sep 17 00:00:00 2001 From: James Chainey Date: Tue, 6 Jan 2026 18:13:05 -0800 Subject: [PATCH] updated some readme language --- README.md | 31 ++++++++++++++++----- packages/scripts/src/step1-runloop-setup.ts | 2 +- 2 files changed, 25 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3a49af0..63b6e55 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Use agentic AI on Runloop to create a (fake) tax preparation service. -**⚠️ IMPORTANT: This is a demonstration system only. Do not use for actual tax preparation or filing. Do not upload real personal or tax information.** +**⚠️ IMPORTANT: This is a demonstration system only. Do not use for actual tax preparation or filing. Do not upload real personal or tax information. ⚠️** ## Overview @@ -40,7 +40,7 @@ best. - Runloop account and API key (as described in the [Runloop Quickstart](https://docs.runloop.ai/docs/tutorials/quickstart)) - (Optional) Weights & Biases account for LLM tracing with Weave -### Setting up +### Setup & Configuration 1. **Install dependencies** @@ -48,17 +48,34 @@ best. pnpm install ``` -2. **Set up environment variables** +2. **Configure your environment** - Set up your Runloop API key in your local environment: + Set up your API keys in your local environment and configure a .env file. + + First, visit the [https://platform.runloop.ai/settings](settings) page on Runloop. + + a. Create a Runloop API key in the [https://platform.runloop.ai/settings](settings) page. + + b. Generate an OpenAI API key using the [https://platform.openai.com/settings/organization/api-keys](OpenAI console). + + c. Create a Secret for the OpenAI key you just generated in the [https://platform.runloop.ai/settings](settings) page. Name the secret name `OPENAI_API_KEY` and paste the key value from the OpenAI site. + + d. Now configure your environment: ```bash export RUNLOOP_API_KEY= + cp packages/tax-processing/.env.example packages/tax-processing/.env + ``` + + Open the `.env` file and update values where prompted. + + e. Launch the environment to test the setup: + + ```bash + pnpm dev ``` - And add your OPENAI_API_KEY as a Runloop secret. - TODO: point to the docs on how to do this - TODO: specify the name needed + Then open your browser and go to the [http://localhost:3000/](demo site). 3. **(Optional) Enable Weave Tracing** diff --git a/packages/scripts/src/step1-runloop-setup.ts b/packages/scripts/src/step1-runloop-setup.ts index 791b83b..93ccdaa 100644 --- a/packages/scripts/src/step1-runloop-setup.ts +++ b/packages/scripts/src/step1-runloop-setup.ts @@ -368,7 +368,7 @@ EOR console.log(` ✓ Base blueprint created: ${baseBlueprint.id}`); - let baseBlueprintInfo = await baseBlueprint.getInfo(); + const baseBlueprintInfo = await baseBlueprint.getInfo(); if (baseBlueprintInfo.status === 'build_complete') { console.log(` ✓ Base blueprint build completed successfully! \n`); } else {