Add README

This commit is contained in:
Tat Dat Duong
2025-02-18 19:41:47 +01:00
parent 3a2073e76e
commit 7448b33075
3 changed files with 32 additions and 70 deletions

View File

@@ -1,50 +1,12 @@
# React + TypeScript + Vite
# agent-ui demo
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
## Setup
Currently, two official plugins are available:
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
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
## Expanding the ESLint configuration
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
- Configure the top-level `parserOptions` property like this:
```js
export default tseslint.config({
languageOptions: {
// other options...
parserOptions: {
project: ['./tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: import.meta.dirname,
},
},
})
```
- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
- Optionally add `...tseslint.configs.stylisticTypeChecked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
```js
// eslint.config.js
import react from 'eslint-plugin-react'
export default tseslint.config({
// Set the react version
settings: { react: { version: '18.3' } },
plugins: {
// Add the react plugin
react,
},
rules: {
// other rules...
// Enable its recommended rules
...react.configs.recommended.rules,
...react.configs['jsx-runtime'].rules,
},
})
```
TODO: will create RC packages down the line, but just too lazy for now.