Back to Crewai

React Component Export

docs/en/enterprise/guides/react-component-export.mdx

1.14.5a23.1 KB
Original Source

This guide explains how to export CrewAI AMP crews as React components and integrate them into your own applications.

Exporting a React Component

<Steps> <Step title="Export the Component"> Click on the ellipsis (three dots on the right of your deployed crew) and select the export option and save the file locally. We will be using `CrewLead.jsx` for our example.
    <Frame>
        
    </Frame>
</Step>
</Steps>

Setting Up Your React Environment

To run this React component locally, you'll need to set up a React development environment and integrate this component into a React project.

<Steps> <Step title="Install Node.js"> - Download and install Node.js from the official website: https://nodejs.org/ - Choose the LTS (Long Term Support) version for stability. </Step>
<Step title="Create a new React project">
    - Open Command Prompt or PowerShell
    - Navigate to the directory where you want to create your project
    - Run the following command to create a new React project:

        ```bash
        npx create-react-app my-crew-app
        ```
    - Change into the project directory:

        ```bash
        cd my-crew-app
        ```
</Step>

<Step title="Install necessary dependencies">
    ```bash
    npm install react-dom
    ```
</Step>

<Step title="Create the CrewLead component">
    - Move the downloaded file `CrewLead.jsx` into the `src` folder of your project,
</Step>

<Step title="Modify your App.js to use the CrewLead component">
    - Open `src/App.js`
    - Replace its contents with something like this:

    ```jsx
    import React from 'react';
    import CrewLead from './CrewLead';

    function App() {
        return (
            <div className="App">
                <CrewLead baseUrl="YOUR_API_BASE_URL" bearerToken="YOUR_BEARER_TOKEN" />
            </div>
        );
    }

    export default App;
    ```
    - Replace `YOUR_API_BASE_URL` and `YOUR_BEARER_TOKEN` with the actual values for your API.
</Step>

<Step title="Start the development server">
    - In your project directory, run:

        ```bash
        npm start
        ```
    - This will start the development server, and your default web browser should open automatically to http://localhost:3000, where you'll see your React app running.
</Step>
</Steps>

Customization

You can then customise the CrewLead.jsx to add color, title etc

<Frame> </Frame> <Frame> </Frame>

Next Steps

  • Customize the component styling to match your application's design
  • Add additional props for configuration
  • Integrate with your application's state management
  • Add error handling and loading states