ContextQMD
Back to Copilotkit

Step 2: Setup CopilotKit

docs/content/docs/integrations/built-in-agent/tutorials/ai-todo-app/step-2-setup-copilotkit.mdx

1.59.43.4 KB
Original Source

import SelfHostingCopilotRuntimeCreateEndpoint from "@/snippets/self-hosting-copilot-runtime-create-endpoint.mdx"; import CopilotCloudConfigureCopilotKitProvider from "@/snippets/copilot-cloud-configure-copilotkit-provider.mdx"; import SelfHostingCopilotRuntimeConfigureCopilotKitProvider from "@/snippets/self-hosting-copilot-runtime-configure-copilotkit-provider.mdx"; import { TailoredContent, TailoredContentOption, } from "@/components/react/tailored-content"; import { FaCloud, FaServer } from "react-icons/fa";

Now that we have our todo list app running, we're ready to integrate CopilotKit. For this tutorial, we will install the following dependencies:

  • @copilotkit/react-core: The core library for CopilotKit, which contains the CopilotKit provider and useful hooks.
  • @copilotkit/react-ui: The UI library for CopilotKit, which contains the CopilotKit UI components such as the sidebar, chat popup, textarea and more.

Install Dependencies

To install the CopilotKit dependencies, run the following:

npm
npm install @copilotkit/react-core @copilotkit/react-ui

Setup CopilotKit

<TailoredContent id="hosting"> <TailoredContentOption id="copilot-cloud" title="Copilot Cloud (Recommended)" description="Use our hosted backend endpoint to get started quickly." icon={<FaCloud />} > In order to use CopilotKit, we'll need to configure the `CopilotKit` provider. <CopilotCloudConfigureCopilotKitProvider components={props.components} /> </TailoredContentOption> <TailoredContentOption id="self-hosted" title="Self-hosting" description="Learn to host CopilotKit's runtime yourself with your own backend." icon={<FaServer />} > <Steps> <Step> ### Set up Copilot Runtime Endpoint <SelfHostingCopilotRuntimeCreateEndpoint components={props.components} /> </Step> <Step>

Configure the CopilotKit Provider

<SelfHostingCopilotRuntimeConfigureCopilotKitProvider components={props.components} />

</Step> </Steps> </TailoredContentOption> </TailoredContent>

CopilotKit Chat Popup

We provide several plug-and-play components for you to interact with your copilot. Some of these are <CopilotPopup/>, <CopilotSidebar/>, and <CopilotChat/>. You can of course use CopilotKit in headless mode and provide your own fully custom UI via useCopilotChat.

In this tutorial, we'll use the <CopilotPopup/> component to display the chat popup.

tsx
"use client";

import { TasksList } from "@/components/TasksList";
import { TasksProvider } from "@/lib/hooks/use-tasks";
import { CopilotKit } from "@copilotkit/react-core";
import { CopilotPopup } from "@copilotkit/react-core/v2"; // [!code highlight]
import "@copilotkit/react-ui/v2/styles.css"; // [!code highlight]

export default function Home() {
  return (
    <>
      <TasksProvider>
        <TasksList />
      </TasksProvider>
      <CopilotPopup />
    </>
  );
}

Here's what we did:

  • We imported the <CopilotPopup /> component from @copilotkit/react-ui.
  • We wrapped the page with the <CopilotKit> provider.
  • We imported the built-in styles from @copilotkit/react-ui.

Now, head back to your app and you'll find a chat popup in the bottom right corner of the page. At this point, you can start interacting with your copilot! 🎉

In the next step, we'll make our assistant smarter by providing it with readable state about our todo list.