Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Fix broken links in app README, support .venv convention #4821

Merged
merged 1 commit into from
Oct 1, 2024
Merged

chore: Fix broken links in app README, support .venv convention #4821

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
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
cephalization marked this conversation as resolved.
Show resolved Hide resolved
6 changes: 3 additions & 3 deletions app/README.md
View file
Open in desktop
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
Loading