Installation

Get started with melony in your React project.

Install

Install melony using your preferred package manager:

Using pnpm (recommended)

pnpm add melony

Using npm

npm install melony

Using yarn

yarn add melony

Requirements

React >= 18

melony requires React 18 or higher for optimal performance and features.

Server Route

A server route that returns text/event-stream for streaming responses.

TypeScript Support

melony is built with TypeScript and provides full type safety out of the box. No additional type definitions needed.

Note: While melony works with JavaScript, we highly recommend using TypeScript to get the full benefits of type safety and better developer experience.

Next Steps

1. Quickstart

Follow our quickstart guide to build your first chat interface.

Go to Quickstart →

2. Server Setup

Learn how to set up your server endpoint for streaming responses.

Go to Server Integration →