From f61e02643fec5a8966db616308b67203b4c9f2ad Mon Sep 17 00:00:00 2001 From: Tony Powell Date: Tue, 1 Oct 2024 10:41:51 -0400 Subject: [PATCH] chore: Fix broken links in app README, support alternate virtual envs --- .gitignore | 3 +++ app/README.md | 6 +++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 1556d78aae..ab89cef217 100644 --- a/.gitignore +++ b/.gitignore @@ -30,4 +30,7 @@ pyrightconfig.json tutorials/internal/demo_llama_index/*.json examples/agent_framework_comparison/utils/saved_traces/*.parquet .env + +# python environments .conda +.venv diff --git a/app/README.md b/app/README.md index 9f794e2f57..7e9ac4f7b2 100644 --- a/app/README.md +++ b/app/README.md @@ -20,13 +20,13 @@ To develop the UI, you must run the `app` in conjunction with the backend server pnpm run dev ``` -Before running the script above you should configure your running environment by creating a `.env` file in the root of the project. You can find an example of the `.env` file in the `.env.example` file. +Before running the script above you should configure your running environment by creating a `.env` file besides the `.env.example` file in the root of this project. You can find an example of the `.env` file in the `.env.example` file. -Depending on what flows you are trying to build features for, you may want to adjust the scripts block within the (package.json)[./package.json] file so that the server is serving the appropriate fixture data. +Depending on what flows you are trying to build features for, you may want to adjust the scripts block within the [package.json](./package.json) file so that the server is serving the appropriate fixture data. ## Build -The app is written in `typescript` and leverages [esbuild](https://esbuild.github.io/) as well as the (relay-compiler)[https://relay.dev/docs/guides/compiler/] to compile highly efficient `graphql` queries. Because of this, the build script involves: +The app is written in `typescript` and leverages [esbuild](https://esbuild.github.io/) as well as the [relay-compiler](https://relay.dev/docs/guides/compiler/) to compile highly efficient `graphql` queries. Because of this, the build script involves: 1. Building the `javascript` and `css` assets using `esbuild` 2. Building the compiled graphql queries using the `relay-compiler`