Skip to content

Commit 57c9c2e

Browse files
HomunMageHomunMage
committed
doc update
1 parent 98ba04e commit 57c9c2e

File tree

11 files changed

+119
-68
lines changed

11 files changed

+119
-68
lines changed

‎About/index.md

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

‎Others/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ If you want to learn more about LangGraph, we also have [learning LangGraph for
44

55
## deprecated projects
66

7-
* old reactflow ver: [LangGraph-GUI-reactflow](https://github.com/LangGraph-GUI/LangGraph-GUI-reactflow)
8-
* old js version: [LangGraph-GUI](https://github.com/LangGraph-GUI/LangGraph-GUI/tree/0.6.1)
9-
* old flask version: [backend](https://github.com/LangGraph-GUI/LangGraph-GUI-backend/tree/flask)
10-
* old Qt version: [LangGraph-GUI-Qt](https://github.com/LangGraph-GUI/LangGraph-GUI-backend/tree/GUI-Qt)
11-
* old Qt version: [CrewAI-GUI](https://github.com/LangGraph-GUI/CrewAI-GUI)
7+
* old react ts ver: [LangGraph-GUI-reactflow](https://github.com/LangGraph-GUI/LangGraph-GUI-reactflow)
8+
* old react js frontend: [LangGraph-GUI](https://github.com/LangGraph-GUI/LangGraph-GUI/tree/0.6.1)
9+
* old flask backend:[backend](https://github.com/LangGraph-GUI/LangGraph-GUI-backend/tree/flask)
10+
* old Qt GUI frontend: [LangGraph-GUI-Qt](https://github.com/LangGraph-GUI/LangGraph-GUI-backend/tree/GUI-Qt)
11+
* old Qt version for CrewAI: [CrewAI-GUI](https://github.com/LangGraph-GUI/CrewAI-GUI)

‎Others/Windows.md renamed to ‎Setup/Windows.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,44 @@
1+
---
2+
layout: page/note/basic
3+
---
4+
15
# LangGraph GUI Setup on Windows
26

37
This guide will help you set up and run the LangGraph-GUI, both backend and frontend, on a Windows environment, using environment variables for backend port and Ollama URL.
48

5-
## Prerequisites
9+
### Prerequisites
610

711
Before you begin, ensure you have the following installed on your system:
812

13+
- **Codebase**
914
- **Python or Conda**
1015
- **npm**
1116
- **Ollama**
1217

18+
## Download repos
19+
```bash
20+
git clone --recursive https://github.com/LangGraph-GUI/LangGraph-GUI
21+
```
22+
23+
## Ollama Setup
24+
25+
1. Download Ollama from official
26+
27+
https://ollama.com/download
28+
29+
2. **Open Another PowerShell Terminal**
30+
Open another PowerShell terminal window.
31+
32+
3. **Start Ollama**
33+
Run the Ollama service:
34+
```bash
35+
ollama serve
36+
```
37+
1338
## Backend Setup
1439

1540
1. **Open a PowerShell Terminal**
16-
Open a PowerShell terminal window to start the setup process.
41+
Open another PowerShell terminal window to start the setup process.
1742

1843
2. **Create a Conda Environment (Optional)**
1944
Create a new Conda environment for the LangGraph backend:
@@ -73,7 +98,7 @@ Before you begin, ensure you have the following installed on your system:
7398
**frontend need dep**
7499
Clone the LangGraph frontend repository from GitHub:
75100
```bash
76-
git clone --recursive https://github.com/LangGraph-GUI/LangGraph-GUI-frontend
101+
-frontend
77102
```
78103

79104
3. **Navigate to the Frontend Directory**
@@ -94,16 +119,6 @@ Before you begin, ensure you have the following installed on your system:
94119
npm start
95120
```
96121

97-
## Ollama Setup
98-
99-
1. **Open Another PowerShell Terminal**
100-
Open another PowerShell terminal window.
101-
102-
2. **Start Ollama**
103-
Run the Ollama service:
104-
```bash
105-
ollama serve
106-
```
107122

108123
## Conclusion
109124

‎Setup/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Setup
2+
3+
## Windows
4+
5+
see [Windows Setup](./Windows.md)
6+
7+
## Linux - Docker Compose
8+
9+
see [Docker Compose Setup](https://github.com/LangGraph-GUI/LangGraph-GUI?tab=readme-ov-file#getting-started)
10+
11+
## Linux - K8s
12+
13+
see [K8S Setup](https://github.com/LangGraph-GUI/LangGraph-GUI/tree/main/k8s#readme)

‎_includes

‎_layouts/base.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@
3838

3939
{%- include footer.html -%}
4040

41-
<script src="https://posetmage.com/cdn/js/EmailEncoder.js"></script>
4241
<script src="https://posetmage.com/cdn/js/SearchSite.js"></script>
4342
<script src="https://posetmage.com/cdn/js/PageTrigger.js"></script>
4443

‎_layouts/frontend.html

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,54 @@
22
layout: base
33
---
44

5-
{% include sidebar.html%}
5+
<head>
6+
<style>
7+
.page-container {
8+
display: flex;
9+
flex-wrap: wrap; /* Allow items to wrap as needed */
10+
word-wrap: break-word;
11+
}
12+
13+
.sidebar p {
14+
margin: 0;
15+
padding: 0;
16+
line-height: 1.2em;
17+
}
18+
19+
.sidebar {
20+
position: fixed;
21+
flex: 0 0 12em; /* Fixed width for the sidebar */
22+
width: 130px;
23+
}
24+
25+
.page-content {
26+
flex-grow: 1; /* Consumes the rest of the space */
27+
margin-left: 200px;
28+
margin-right: 200px;
29+
max-width: calc(100% - 150px);
30+
}
31+
32+
</style>
33+
</head>
34+
35+
</style>
36+
37+
<div class="page-container">
38+
<aside class="sidebar" id="outline">
39+
<!-- Sidebar content will be loaded here -->
40+
</aside>
41+
42+
<main class="page-content">
43+
<article class="post">
44+
{% seo %}
45+
<div class="post-content">
46+
{{ content }}
47+
</div>
48+
<div id="randomPostsContainer"></div>
49+
</article>
50+
</main>
51+
52+
</div>
653

754
<script>
855
document.addEventListener('DOMContentLoaded', function() {
@@ -12,6 +59,4 @@
1259
document.getElementById('outline').innerHTML = data;
1360
});
1461
});
15-
</script>
16-
17-
62+
</script>

‎_layouts/page

‎index.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,33 @@
11
---
22
layout: base
3+
title: LangGraph-GUI
34
---
45

5-
# [LangGraph-GUI](https://github.com/LangGraph-GUI/LangGraph-GUI/)
6+
[LangGraph-GUI](https://github.com/LangGraph-GUI/LangGraph-GUI) is a self-host, user-friendly interface designed for editing Node-Edge workflow graphs using LangGraph. This tool supports creating, editing, and running workflows with local language models such Ollama. It can be easily deployed using Docker Compose or K8s(Kubernetes).
67

7-
Welcome to the [LangGraph-GUI](https://github.com/LangGraph-GUI/LangGraph-GUI/) documentation!
8+
![LangGraph-GUI](/cover.webp)
89

9-
- To understand more about this project, visit the [About](/About) page.
10-
- For steps on using the GUI frontend, check out the [Frontend](/Frontend) documentation.
11-
- To explore backend details, see the [Backend](/Backend) documentation.
12-
- For Windows OS user, see [Windows](/Others/Windows)
13-
- For additional resources and related side projects, visit the [Others](/Others) page.
10+
## Components
1411

15-
If you have any questions or would like to leave a message, please use our [GitHub Discussions](https://github.com/LangGraph-GUI/LangGraph-GUI/discussions) page.
12+
LangGraph-GUI comprises the following main components:
1613

17-
![LangGraph-GUI](/cover.webp)
14+
- **[Frontend](/Frontend)**: The default frontend is built with SvelteFlow, providing an intuitive interface for graph editing.
15+
- **[Backend](/Backend)**: The backend is implemented using Flask, offering a robust and scalable server-side solution.
16+
- AI-end
17+
- For running local language models with Ollama AI service, we recommend using NVIDIA Docker.
18+
- [selfhost](/Setup)
19+
- For Linux user, just see github repo
20+
- For Windows OS user, see [Windows](/Setup/Windows)
1821

22+
- For additional resources and related side projects, visit the [Others](/Others) page.
1923

20-
## Update log and future works:
21-
* [update log](https://github.com/LangGraph-GUI/LangGraph-GUI/blob/main/CHANGELOG.md)
22-
* [task manager](https://github.com/orgs/LangGraph-GUI/projects)
2324

25+
*If you want to learn more about LangGraph, we also have [learning LangGraph for dummy](https://github.com/LangGraph-GUI/LangGraph-learn)*
2426

2527
## Others
26-
We hope you find the information you need. If you have any questions, feel free to reach out!
28+
29+
- If you have any questions or would like to leave a message, please use our [GitHub Discussions](https://github.com/LangGraph-GUI/LangGraph-GUI/discussions) page, or just open issue.
30+
31+
- [update log](https://github.com/LangGraph-GUI/LangGraph-GUI/blob/main/CHANGELOG.md)
32+
33+
- We hope you find the information you need. If you have any questions, feel free to reach out!

‎social-media-list.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎trigger.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<a class="page-link" href="/About/">About</a>
1+
<a class="page-link" href="/Setup/">Setup</a>
22
<a class="page-link" href="/Frontend/">Frontend</a>
33
<a class="page-link" href="/Backend/">Backend</a>
44
<a class="page-link" href="/Others/">Others</a>

0 commit comments

Comments
 (0)