Skip to content

Commit

Permalink
new ver update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
HomunMage committed Jan 5, 2025
1 parent 7d1adde commit c423a57
Show file tree
Hide file tree
Showing 17 changed files with 109 additions and 49 deletions.
36 changes: 34 additions & 2 deletions Backend/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,41 @@

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)

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

Current implementation only runs graph.json, need frontend upload.
## Json Format

json node format like this:
you can extend ext to put your data, this is elastic design.
for example, the ext.info is a ext and able to parse in our backend.
```
{
"nodes": [
{
"uniq_id": "1",
"nexts": [
"2"
],
"type": "START",
"name": "Node 1",
"description": "",
"tool": "",
"true_next": null,
"false_next": null,
"ext": {
"pos_x": 126,
"pos_y": 146,
"width": 200,
"height": 200,
"info": ""
}
},
```


This use FastAPI server to communicate with frontend.

Current implementation only runs graph.json.

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

Expand Down
4 changes: 4 additions & 0 deletions Frontend/Graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,7 @@ CONDITION node will mapping to LangGraph conditional_edge
## Other Resource
*If you want to learn more about LangGraph, we have LangGraph for dummy : [LangGraph-learn](https://github.com/LangGraph-GUI/LangGraph-learn)*

#### Information Node
INFO node do nothing, just append info to previous stage output

![](images/info.webp)
11 changes: 4 additions & 7 deletions Frontend/Run.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,13 @@ layout: frontend
This will Run graph.json on server.
That is, you need upload graph.json first.

![](./images/run.webp)
![](./images/run_window.webp)

## Run
Execute graph.json into LangGraph with Ollama.
After Run, recommand download files.
Execute graph.json into LangGraph with LLM.
After Run, recommand get files from server.

## Stop
To terminal remote running server. (Currently, many bugs. If stuck, plese restart docker compose)

## Cancel
## Leave
Leave run menu

## Text Space
Expand Down
32 changes: 0 additions & 32 deletions Frontend/UI.md

This file was deleted.

29 changes: 29 additions & 0 deletions Frontend/UI1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
layout: frontend

---


# UI

There are several buttoms
![](./images/panel_major.webp)

## New Graph

New will clean the canvas.

## Save Graph

Save the graph into json to your computer.

## Load Graph
Read the graph json from your computer.

## Run Graph
Run graph.json on server, for more info, see [Run](./Run)


## Config
* set what llm you want to use
* api key
21 changes: 21 additions & 0 deletions Frontend/UI2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
layout: frontend

---


# UI

There are several buttoms
![](./images/panel_server.webp)

## Upload Files to Server

Send file to workspace as environment, for such file processing.

## Get Files from Server

After process with LLM, download all files in workspace.

## Clean Server Cache
Remove all files at workspace
Binary file removed Frontend/images/button.webp
Binary file not shown.
Binary file added Frontend/images/info.webp
Binary file not shown.
Binary file added Frontend/images/panel_major.webp
Binary file not shown.
Binary file added Frontend/images/panel_server.webp
Binary file not shown.
Binary file removed Frontend/images/run.webp
Binary file not shown.
Binary file added Frontend/images/run_window.webp
Binary file not shown.
7 changes: 4 additions & 3 deletions Frontend/outline.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<h2>Frontend</h2>

<a href="/Frontend/">About</a></br>
<a href="/Frontend/UI">UI</a></br>
<a href="/Frontend/Graph">Graph</a></br>
<a href="/Frontend/UI1">UI1</a></br>
<a href="/Frontend/UI2">UI2</a></br>
<a href="/Frontend/Graph">Graph UI</a></br>
<a href="/Frontend/Examples">Examples</a></br>
<a href="/Frontend/Run">Run</a></br>
<a href="/Frontend/Run">Run</a></br>
6 changes: 3 additions & 3 deletions Others/Windows.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# LangGraph GUI Setup on Windows


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

## Prerequisites

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

2. **Clone the Frontend Repository**
**frontend need dep**
Clone the LangGraph frontend repository from GitHub:
```bash
git clone https://github.com/LangGraph-GUI/LangGraph-GUI-frontend
git clone --recursive https://github.com/LangGraph-GUI/LangGraph-GUI-frontend
```

3. **Navigate to the Frontend Directory**
Expand Down
2 changes: 2 additions & 0 deletions Others/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ If you want to learn more about LangGraph, we also have [learning LangGraph for
We have Qt version: [LangGraph-GUI-Qt](https://github.com/LangGraph-GUI/LangGraph-GUI-Qt)

We also have Qt version of [CrewAI-GUI](https://github.com/LangGraph-GUI/CrewAI-GUI)

[Flask ver backend](https://github.com/LangGraph-GUI/LangGraph-GUI-backend-flask)
Binary file modified cover.webp
Binary file not shown.
10 changes: 8 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ layout: base

---

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

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

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

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


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

0 comments on commit c423a57

Please sign in to comment.