Templates

The easiest way to get started with Echo is to use one of our pre-built templates.

React

The React template is a simple application that uses Vite and echo-react-sdk. Uniquely Echo does not require a server to make API calls because it handles Oauth directly in the browser.

Create an Echo App

Go to echo.merit.systems/new to get an app_id.

Create a React app using Vite

Run the following commands to create a new React app using Vite.

npx echo-start@latest --template vite --app-id YOUR_ECHO_APP_ID

yarn dlx echo-start@latest --template vite --app-id YOUR_ECHO_APP_ID

pnpx echo-start@latest --template vite --app-id YOUR_ECHO_APP_ID

bunx echo-start@latest --template vite --app-id YOUR_ECHO_APP_ID

Next.js

The Next.js template is a full-stack application that uses the Next.js framework with the echo-next-sdk.

Create an Echo app

Go to echo.merit.systems/new to get an app_id.

Create a Next.js app

Run the following commands to create a new Next.js app.

npx echo-start@latest --template next --app-id YOUR_ECHO_APP_ID

yarn dlx echo-start@latest --template next --app-id YOUR_ECHO_APP_ID

pnpx echo-start@latest --template next --app-id YOUR_ECHO_APP_ID

bunx echo-start@latest --template next --app-id YOUR_ECHO_APP_ID

Assistant UI

A full-featured chat UI powered by @assistant-ui/react integrated with Echo and the Vercel AI SDK v5.

Create an Echo App

Go to echo.merit.systems/new to get an app_id.

Scaffold the Assistant UI template

Use degit to copy the example into a new directory.

npx degit Merit-Systems/echo/examples/assistant-ui my-assistant-ui
cd my-assistant-ui
npm install

yarn dlx degit Merit-Systems/echo/examples/assistant-ui my-assistant-ui
cd my-assistant-ui
yarn install

pnpx degit Merit-Systems/echo/examples/assistant-ui my-assistant-ui
cd my-assistant-ui
pnpm install

bunx degit Merit-Systems/echo/examples/assistant-ui my-assistant-ui
cd my-assistant-ui
bun install

Configure environment

Create a .env.local file and set your Echo App ID:

NEXT_PUBLIC_ECHO_APP_ID=YOUR_ECHO_APP_ID

Run the app

pnpm dev

On this page