You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/dev-environment.md
+17-7Lines changed: 17 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,9 +18,19 @@ If you just want to use Invoke, you should use the [launcher][launcher link].
18
18
19
19
2.[Fork and clone][forking link] the [InvokeAI repo][repo link].
20
20
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
-
23
-
4. Follow the [manual install][manual install link] guide, with some modifications to the install command:
21
+
3. This repository uses Git LFS to manage large files. To ensure all assets are downloaded:
- Enable automatic LFS fetching for this repository:
24
+
```shell
25
+
git config lfs.fetchinclude "*"
26
+
```
27
+
- Fetch files from LFS (only needs to be done once; subsequent `git pull` will fetch changes automatically):
28
+
```
29
+
git lfs pull
30
+
```
31
+
4. 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.
32
+
33
+
5. Follow the [manual install][manual install link] guide, with some modifications to the install command:
24
34
25
35
- Use `.` instead of `invokeai` to install from the current directory. You don't need to specify the version.
26
36
@@ -34,27 +44,27 @@ If you just want to use Invoke, you should use the [launcher][launcher link].
5. At this point, you should have Invoke installed, a venv set up and activated, and the server running. But you will see a warning in the terminal that no UI was found. If you go to the URL for the server, you won't get a UI.
47
+
6. At this point, you should have Invoke installed, a venv set up and activated, and the server running. But you will see a warning in the terminal that no UI was found. If you go to the URL for the server, you won't get a UI.
38
48
39
49
This is because the UI build is not distributed with the source code. You need to build it manually. End the running server instance.
40
50
41
51
If you only want to edit the docs, you can stop here and skip to the **Documentation** section below.
42
52
43
-
6. Install the frontend dev toolchain:
53
+
7. Install the frontend dev toolchain:
44
54
45
55
- [`nodejs`](https://nodejs.org/) (v20+)
46
56
47
57
- [`pnpm`](https://pnpm.io/8.x/installation) (must be v8 - not v9!)
48
58
49
-
7. Do a production build of the frontend:
59
+
8. Do a production build of the frontend:
50
60
51
61
```sh
52
62
cd<PATH_TO_INVOKEAI_REPO>/invokeai/frontend/web
53
63
pnpm i
54
64
pnpm build
55
65
```
56
66
57
-
8. Restart the server and navigate to the URL. You should get a UI. After making changes to the python code, restart the server to see those changes.
67
+
9. Restart the server and navigate to the URL. You should get a UI. After making changes to the python code, restart the server to see those changes.
0 commit comments