Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .github/workflows/sdk-quality.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: SDK Quality

on:
push:
branches:
- main
paths:
- "sdk/**"
- ".github/workflows/sdk-quality.yml"
pull_request:
paths:
- "sdk/**"
- ".github/workflows/sdk-quality.yml"
workflow_dispatch:

jobs:
lint-and-format:
name: Lint and Prettier
runs-on: ubuntu-latest

defaults:
run:
working-directory: sdk

steps:
- name: Check out repository
uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
cache-dependency-path: sdk/package-lock.json

- name: Install dependencies
run: npm ci

- name: Run ESLint
run: npm run lint

- name: Run Prettier check
run: npm run format:check
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,13 @@
</p>
</div>

Open Chat Widget is a ChatGPT-like AI chat widget for your website. You build your own custom agent, the chat widget handles the UX and plumbing.

Use it to build service agents (free Intercom Fin alternative), knowledge base & documentation search, onboarding assistants, and more. If you're looking to build great AI chat experiences for your users, this is it.
Open Chat Widget lets you drop in a AI chat client right in your product. You just build the backend agent, Open Chat Widget handles the front end UI and plumbing for you.

### Why Open Chat Widget

- **Plug and play** - A single component you drop in to your website. You get access to feature rich AI chat with text streaming, web search, tool use, etc. out of the box. Set up is a few lines of code.

- **Build any AI agent** — Build custom agents with [Vercel AI SDK](https://ai-sdk.dev/). Use any LLM model and create custom workflows. Works directly with existing AI-SDK endpoints.
- **Works with AI SDK** — Build custom agents with [Vercel AI SDK](https://ai-sdk.dev/). Use any LLM model and create custom workflows. Works directly with existing AI-SDK endpoints.

- **Framework-agnostic** — Plugs in to any web framework or website platform: React, Next.js, Vue, WordPress, Shopify, Wix.

Expand Down
1 change: 1 addition & 0 deletions sdk/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dist
31 changes: 31 additions & 0 deletions sdk/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import js from "@eslint/js";
import globals from "globals";
import tseslint from "typescript-eslint";

export default tseslint.config(
{
ignores: ["dist/**"],
},
js.configs.recommended,
...tseslint.configs.recommended,
{
files: ["widget/src/**/*.{ts,tsx}"],
languageOptions: {
ecmaVersion: 2022,
sourceType: "module",
globals: {
...globals.browser,
...globals.node,
},
},
rules: {
"@typescript-eslint/no-unused-vars": [
"error",
{
argsIgnorePattern: "^_",
varsIgnorePattern: "^_",
},
],
},
},
);
Loading
Loading