Install and configure qchat

Follow the source instructions for qchat. Read the prerequisites and configuration steps before running an example.

Prerequisites

Node.js >=22.13.0
Portable: Windows, macOS, or Linux; no Bash required
Managed Linux: managed Linux runtime with Bash, flock, curl, sha256sum, and GNU timeout
Git is required only for publishing

Install the documented packages

Install @qchat/core, @qchat/server, @qchat/orpc, and @qchat/react as needed. Import @qchat/react/styles.css once. React 19.3 and React DOM 19.3 are peer dependencies; Tailwind is not required in the consuming application because QChat ships its component CSS.

Create the server with createQChatServer, mount the oRPC contract with the handler appropriate to Node, Hono, or Express, then create a browser transport with createQChatClient and place QChatProvider around the thread and composer.

Run the repository showcase

To work on the source and included showcase rather than only consume the libraries, clone this repository and use the locked-install script documented under Diagnostic Commands:

1git clone https://github.com/qentrah/qchat.git
2cd qchat
3npm run install:ci

Then follow the quick-start guide to run the development server. Previewing the built Worker with npm run start requires the local D1/R2 setup described in the reference pages.

Check the installation

After setup, continue with the first example. If a command fails, compare the runtime version, working directory, and required configuration with the original README before changing dependencies.

Source and help

The catalog identifies the license as MIT. Read the repository license before redistributing source or assets.