#Getting Started

#Prerequisites

MateChat React is a React frontend components and helpers library, we recommend that you use React 18 or above.

If you are looking for the MateChat Vue version, please visit MateChat Vue.

#Quick Start

If you wish to try a brand-new MateChat React project, feel free to use the MateChat CLI to create a template project.

npm create matechat@latest

yarn create matechat

pnpm create matechat@latest

bun create matechat@latest

deno init --npm matechat@latest

#Installation

We recommend using the shadcn/ui CLI for a better developer experience with easy component customization and management. Please refer to the shadcn/ui installation guide to configure shadcn/ui first.

For example, install Bubble components via shadcn/ui CLI:

pnpm dlx shadcn@latest add https://matechat.noctisynth.org/r/bubble.json

For more components, visit the Components section.

npm add @matechat/react

yarn add @matechat/react

pnpm add @matechat/react

bun add @matechat/react

deno add npm:@matechat/react

#Find Components

All available components are documented in the Components section.