feat: Add README docs
This commit is contained in:
43
README.md
43
README.md
@@ -1,15 +1,40 @@
|
||||
# Chat LangGraph
|
||||
|
||||
> [!WARNING]
|
||||
> This repo is still a work in progress and is not intended for use. Estimated launch date 03/11. Thank you for your patience.
|
||||
Chat LangGraph is a Vite + React application which enables chatting with any LangGraph server with a `messages` key through a chat interface.
|
||||
|
||||
## Setup
|
||||
|
||||
1. Clone `langgraph` repo and `langgraphjs-api` repo.
|
||||
1. Checkout the following branches:
|
||||
- `langgraph`: `dqbd/sdk-js-react-ui`
|
||||
- `langgraphjs-api`: `dqbd/api-ui`
|
||||
1. Run `npx packserve -d ../langgraph/libs/sdk-js ../langgraphjs-api/libs/langgraph-api ../langgraphjs-api/libs/langgraph-cli`
|
||||
1. Run `pnpm install` while running the `packserve` server
|
||||
> [!TIP]
|
||||
> Don't want to run the app locally? Use the deployed site here: [chat-langgraph.vercel.app](https://chat-langgraph.vercel.app)!
|
||||
|
||||
TODO: will create RC packages down the line, but just too lazy for now.
|
||||
First, clone the repository:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/langchain-ai/chat-langgraph.git
|
||||
|
||||
cd chat-langgraph
|
||||
```
|
||||
|
||||
Install dependencies:
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
Run the app:
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
The app will be available at `http://localhost:5173`.
|
||||
|
||||
## Usage
|
||||
|
||||
Once the app is running (or if using the deployed site), you'll be prompted to enter:
|
||||
|
||||
- **Deployment URL**: The URL of the LangGraph server you want to chat with. This can be a production or development URL.
|
||||
- **Assistant/Graph ID**: The name of the graph, or ID of the assistant to use when fetching, and submitting runs via the chat interface.
|
||||
- **LangSmith API Key**: (only required for connecting to deployed LangGraph servers) Your LangSmith API key to use when authenticating requests sent to LangGraph servers.
|
||||
|
||||
After entering these values, click `Continue`. You'll then be redirected to a chat interface where you can start chatting with your LangGraph server.
|
||||
|
||||
Reference in New Issue
Block a user