Skip to content

Commit 7ca8441

Browse files
chore: Update web dev docs (#6262)
* Update web dev docs * Tweak docs slightly
1 parent 9557db9 commit 7ca8441

File tree

2 files changed

+22
-9
lines changed

2 files changed

+22
-9
lines changed

.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v22.13.1

DEVELOPMENT.md

+21-9
Original file line numberDiff line numberDiff line change
@@ -41,26 +41,38 @@ Create a new virtual environment with a Phoenix-compatible Python version. For e
4141
conda create --name phoenix python=3.8
4242
```
4343

44-
Install web build dependencies
45-
[nodejs via nvm](https://github.com/nvm-sh/nvm) - LTS should work in most cases
46-
[pnpm](https://pnpm.io/) - `npm install -g pnpm`
47-
Make sure you have pnpm (node package manager) available on your terminal as well
44+
Second, install the web build dependencies.
4845

49-
Install `phoenix` in development mode (using the `-e` flag) and with development dependencies (using the `[dev,test]` extra) by running
46+
We recommend installing [nodejs via nvm](https://github.com/nvm-sh/nvm) and then
47+
installing `pnpm` globally to manage the web frontend dependencies.
5048

5149
```bash
52-
pip install -e ".[dev,test]"
50+
# install nvm
51+
# https://github.com/nvm-sh/nvm
52+
# install node via nvm, our .nvmrc file will automatically instruct nvm to install
53+
# the version specified in the file
54+
nvm install
55+
# set it as default (optional)
56+
nvm alias default <version-that-was-installed>
57+
# install pnpm globally for v22
58+
5359
```
5460

55-
from the repository root.
56-
57-
You will also need to build the web app. Change directory to `app` and run:
61+
Then we will build the web app. Change directory to `app` and run:
5862

5963
```bash
6064
pnpm install
6165
pnpm run build
6266
```
6367

68+
Finally, change directory back to repository root and install `phoenix` in
69+
development mode (using the `-e` flag), and with development dependencies
70+
(using the `[dev,test]` extra) by running
71+
72+
```bash
73+
pip install -e ".[dev,test]"
74+
```
75+
6476
If you are working on our LLM orchestration framework integrations, you may also wish to install LlamaIndex or LangChain from source. To install LlamaIndex from source,
6577

6678
- Uninstall any pre-existing version of LlamaIndex with `pip uninstall llama-index`.

0 commit comments

Comments
 (0)