You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
added more notes to contributing guide for UI (tensorzero#3526)
* added more notes to contributing guide for UI
* Fix formatting for steps in CONTRIBUTING.md
* Update TENSORZERO_EVALUATIONS_PATH in CONTRIBUTING.md
---------
Co-authored-by: Gabriel Bianconi <[email protected]>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -194,22 +194,24 @@ To set it up, follow these steps from the `ui` directory:
194
194
1. Install dependencies: `pnpm install`
195
195
2. Build the internal N-API client for TensorZero using `pnpm -r build`. If you have changed your Rust code, you may also have to run `pnpm build-bindings` from `../internal/tensorzero-node`.
196
196
3. Create a `fixtures/.env` following the `fixtures/.env.example`.
197
-
4. Set the following environment variables:
197
+
4. Run `cargo build`.
198
+
5. Set the following environment variables in your cwd `ui/` (note the previous step edited the vars in `fixtures/`):
# Optional: add provider credentials for optimization workflows
204
206
OPENAI_API_KEY="..."
205
207
FIREWORKS_API_KEY="..."
206
208
FIREWORKS_ACCOUNT_ID="..."
207
209
```
208
-
5. Launch the dependencies: `docker compose -f fixtures/docker-compose.yml up --build --force-recreate`.
210
+
6. Launch the dependencies: `docker compose -f fixtures/docker-compose.yml up --build --force-recreate`.
209
211
You can omit these last 2 flags to skip the build step, but they ensure you're using the latest gateway.
210
-
6. Launch the development server: `pnpm dev`
212
+
7. Launch the development server: `pnpm dev`
211
213
212
-
Separately, you can run headless tests with `pnpm test` and Playwright tests with `pnpm test-e2e`.
214
+
Separately, you can run headless tests with `pnpm test` and Playwright tests with `pnpm test-e2e` (the latter will require a `pnpm exec playwright install`).
213
215
We also maintain a Docker Compose for e2e tests `fixtures/docker-compose.e2e.yml` that is used in CI for the Playwright tests.
214
216
This file uses a different configuration that mandates credentials for image fetching.
0 commit comments