Skip to content

Commit 64e0f6d

Browse files
hippalectryon-0hipsterusername
authored andcommitted
Improve dev install docs
Fix numbering
1 parent ddd5b10 commit 64e0f6d

File tree

1 file changed

+29
-26
lines changed

1 file changed

+29
-26
lines changed

docs/contributing/dev-environment.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -17,46 +17,49 @@ If you just want to use Invoke, you should use the [installer][installer link].
1717
## Setup
1818

1919
1. Run through the [requirements][requirements link].
20-
1. [Fork and clone][forking link] the [InvokeAI repo][repo link].
21-
1. Create an directory for user data (images, models, db, etc). This is typically at `~/invokeai`, but if you already have a non-dev install, you may want to create a separate directory for the dev install.
22-
1. Create a python virtual environment inside the directory you just created:
20+
2. [Fork and clone][forking link] the [InvokeAI repo][repo link].
21+
3. Create an directory for user data (images, models, db, etc). This is typically at `~/invokeai`, but if you already have a non-dev install, you may want to create a separate directory for the dev install.
22+
4. Create a python virtual environment inside the directory you just created:
2323

24-
```sh
25-
python3 -m venv .venv --prompt InvokeAI-Dev
26-
```
24+
```sh
25+
python3 -m venv .venv --prompt InvokeAI-Dev
26+
```
2727

28-
1. Activate the venv (you'll need to do this every time you want to run the app):
28+
5. Activate the venv (you'll need to do this every time you want to run the app):
2929
30-
```sh
31-
source .venv/bin/activate
32-
```
30+
```sh
31+
source .venv/bin/activate
32+
```
3333
34-
1. Install the repo as an [editable install][editable install link]:
34+
6. Install the repo as an [editable install][editable install link]:
3535
36-
```sh
37-
pip install -e ".[dev,test,xformers]" --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu121
38-
```
36+
```sh
37+
pip install -e ".[dev,test,xformers]" --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu121
38+
```
3939
40-
Refer to the [manual installation][manual install link]] instructions for more determining the correct install options. `xformers` is optional, but `dev` and `test` are not.
40+
Refer to the [manual installation][manual install link]] instructions for more determining the correct install options. `xformers` is optional, but `dev` and `test` are not.
4141
42-
1. Install the frontend dev toolchain:
42+
7. Install the frontend dev toolchain:
4343
4444
- [`nodejs`](https://nodejs.org/) (recommend v20 LTS)
45-
- [`pnpm`](https://pnpm.io/installation#installing-a-specific-version) (must be v8 - not v9!)
45+
- [`pnpm`](https://pnpm.io/8.x/installation) (must be v8 - not v9!)
4646
47-
1. Do a production build of the frontend:
47+
8. Do a production build of the frontend:
4848
49-
```sh
50-
pnpm build
51-
```
49+
```sh
50+
cd PATH_TO_INVOKEAI_REPO/invokeai/frontend/web
51+
pnpm i
52+
pnpm build
53+
```
5254
53-
1. Start the application:
55+
9. Start the application:
5456
55-
```sh
56-
python scripts/invokeai-web.py
57-
```
57+
```sh
58+
cd PATH_TO_INVOKEAI_REPO
59+
python scripts/invokeai-web.py
60+
```
5861
59-
1. Access the UI at `localhost:9090`.
62+
10. Access the UI at `localhost:9090`.
6063
6164
## Updating the UI
6265

0 commit comments

Comments
 (0)