Skip to content

Commit

Permalink
chore: Fix broken links in app README, support alternate virtual envs (
Browse files Browse the repository at this point in the history
  • Loading branch information
cephalization authored Oct 1, 2024
1 parent f56cdb8 commit aae4359
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit aae4359

Please sign in to comment.