Skip to content

Commit c423a57

Browse files
HomunMageHomunMage
committed
new ver update doc
1 parent 7d1adde commit c423a57

17 files changed

+109
-49
lines changed

‎Backend/index.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,41 @@
22

33
The core file that convert json to LangGraph is [/src/WorkFlow.py](https://github.com/LangGraph-GUI/LangGraph-GUI-backend/blob/main/src/WorkFlow.py)
44

5-
This use Flask server to communicate with frontend.
5+
[llm.py](https://github.com/LangGraph-GUI/LangGraph-GUI-backend/blob/main/src/llm.py) demo how to replace to different LLM services.
66

7-
Current implementation only runs graph.json, need frontend upload.
7+
## Json Format
8+
9+
json node format like this:
10+
you can extend ext to put your data, this is elastic design.
11+
for example, the ext.info is a ext and able to parse in our backend.
12+
```
13+
{
14+
"nodes": [
15+
{
16+
"uniq_id": "1",
17+
"nexts": [
18+
"2"
19+
],
20+
"type": "START",
21+
"name": "Node 1",
22+
"description": "",
23+
"tool": "",
24+
"true_next": null,
25+
"false_next": null,
26+
"ext": {
27+
"pos_x": 126,
28+
"pos_y": 146,
29+
"width": 200,
30+
"height": 200,
31+
"info": ""
32+
}
33+
},
34+
```
35+
36+
37+
This use FastAPI server to communicate with frontend.
38+
39+
Current implementation only runs graph.json.
840

941
*For a beginner-friendly introduction to LangGraph, visit [LangGraph-learn](https://github.com/LangGraph-GUI/LangGraph-learn).*
1042

‎Frontend/Graph.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,7 @@ CONDITION node will mapping to LangGraph conditional_edge
4040
## Other Resource
4141
*If you want to learn more about LangGraph, we have LangGraph for dummy : [LangGraph-learn](https://github.com/LangGraph-GUI/LangGraph-learn)*
4242

43+
#### Information Node
44+
INFO node do nothing, just append info to previous stage output
45+
46+
![](images/info.webp)

‎Frontend/Run.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,13 @@ layout: frontend
77
This will Run graph.json on server.
88
That is, you need upload graph.json first.
99

10-
![](./images/run.webp)
10+
![](./images/run_window.webp)
1111

1212
## Run
13-
Execute graph.json into LangGraph with Ollama.
14-
After Run, recommand download files.
13+
Execute graph.json into LangGraph with LLM.
14+
After Run, recommand get files from server.
1515

16-
## Stop
17-
To terminal remote running server. (Currently, many bugs. If stuck, plese restart docker compose)
18-
19-
## Cancel
16+
## Leave
2017
Leave run menu
2118

2219
## Text Space

‎Frontend/UI.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎Frontend/UI1.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
layout: frontend
3+
4+
---
5+
6+
7+
# UI
8+
9+
There are several buttoms
10+
![](./images/panel_major.webp)
11+
12+
## New Graph
13+
14+
New will clean the canvas.
15+
16+
## Save Graph
17+
18+
Save the graph into json to your computer.
19+
20+
## Load Graph
21+
Read the graph json from your computer.
22+
23+
## Run Graph
24+
Run graph.json on server, for more info, see [Run](./Run)
25+
26+
27+
## Config
28+
* set what llm you want to use
29+
* api key

‎Frontend/UI2.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: frontend
3+
4+
---
5+
6+
7+
# UI
8+
9+
There are several buttoms
10+
![](./images/panel_server.webp)
11+
12+
## Upload Files to Server
13+
14+
Send file to workspace as environment, for such file processing.
15+
16+
## Get Files from Server
17+
18+
After process with LLM, download all files in workspace.
19+
20+
## Clean Server Cache
21+
Remove all files at workspace

‎Frontend/images/button.webp

-2.62 KB
Binary file not shown.

‎Frontend/images/info.webp

4.12 KB
Binary file not shown.

‎Frontend/images/panel_major.webp

3.24 KB
Binary file not shown.

‎Frontend/images/panel_server.webp

2.79 KB
Binary file not shown.

‎Frontend/images/run.webp

-25.7 KB
Binary file not shown.

‎Frontend/images/run_window.webp

25.1 KB
Binary file not shown.

‎Frontend/outline.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
<h2>Frontend</h2>
22

33
<a href="/Frontend/">About</a></br>
4-
<a href="/Frontend/UI">UI</a></br>
5-
<a href="/Frontend/Graph">Graph</a></br>
4+
<a href="/Frontend/UI1">UI1</a></br>
5+
<a href="/Frontend/UI2">UI2</a></br>
6+
<a href="/Frontend/Graph">Graph UI</a></br>
67
<a href="/Frontend/Examples">Examples</a></br>
7-
<a href="/Frontend/Run">Run</a></br>
8+
<a href="/Frontend/Run">Run</a></br>

‎Others/Windows.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# LangGraph GUI Setup on Windows
22

3-
4-
This guide will help you set up and run the LangGraph GUI application, both backend and frontend, on a Windows environment.
3+
This guide will help you set up and run the LangGraph-GUI, both backend and frontend, on a Windows environment.
54

65
## Prerequisites
76

@@ -58,9 +57,10 @@ Before you begin, ensure you have the following installed on your system:
5857
Open a new PowerShell terminal window.
5958

6059
2. **Clone the Frontend Repository**
60+
**frontend need dep**
6161
Clone the LangGraph frontend repository from GitHub:
6262
```bash
63-
git clone https://github.com/LangGraph-GUI/LangGraph-GUI-frontend
63+
git clone --recursive https://github.com/LangGraph-GUI/LangGraph-GUI-frontend
6464
```
6565

6666
3. **Navigate to the Frontend Directory**

‎Others/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@ If you want to learn more about LangGraph, we also have [learning LangGraph for
77
We have Qt version: [LangGraph-GUI-Qt](https://github.com/LangGraph-GUI/LangGraph-GUI-Qt)
88

99
We also have Qt version of [CrewAI-GUI](https://github.com/LangGraph-GUI/CrewAI-GUI)
10+
11+
[Flask ver backend](https://github.com/LangGraph-GUI/LangGraph-GUI-backend-flask)

‎cover.webp

9.24 KB
Binary file not shown.

‎index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ layout: base
33

44
---
55

6-
# LangGraph-GUI
6+
# [LangGraph-GUI](https://github.com/LangGraph-GUI/LangGraph-GUI/)
77

8-
Welcome to the LangGraph-GUI project documentation!
8+
Welcome to the [LangGraph-GUI](https://github.com/LangGraph-GUI/LangGraph-GUI/) documentation!
99

1010
- To understand more about this project, visit the [About](/About) page.
1111
- For steps on using the GUI frontend, check out the [Frontend](/Frontend) documentation.
@@ -19,3 +19,9 @@ If you have any questions or would like to leave a message, please use our [GitH
1919

2020
We hope you find the information you need. If you have any questions, feel free to reach out!
2121

22+
23+
## Update log and future works:
24+
* [general log](https://github.com/LangGraph-GUI/LangGraph-GUI/blob/main/CHANGELOG.md)
25+
* [frontend log](https://github.com/LangGraph-GUI/LangGraph-GUI-frontend/blob/main/CHANGELOG.md)
26+
* [backend log](https://github.com/LangGraph-GUI/LangGraph-GUI-backend/blob/main/CHANGELOG.md)
27+
* [task manager](https://github.com/orgs/LangGraph-GUI/projects)

0 commit comments

Comments
 (0)