@aptos-labs/ai-chatbot-client

A React-based chatbot interface for the Aptos Developer Assistant API. This package provides a customizable chat interface component that can be integrated into any React application.

Installation

npm install @aptos-labs/ai-chatbot-client
# or
yarn add @aptos-labs/ai-chatbot-client
# or
pnpm add @aptos-labs/ai-chatbot-client

Usage

import { ChatInterface } from '@aptos-labs/ai-chatbot-client';

function App() {
  return (
    <ChatInterface
      apiUrl="https://your-api-url"
      // Add other props as needed
    />
  );
}

Development

Prerequisites

• Node.js 16+
• pnpm 9+

Setup

1. Install dependencies:

pnpm install

2. Build the package:

pnpm build

Release Process

This package uses Changesets for version management and releases.

Prerequisites for Publishing

To publish new versions of this package, you need:

1. Access to the @aptos-labs organization on npm
2. Proper authentication set up with npm
3. Membership in the Aptos Labs GitHub organization

If you don't have these permissions, please contact the Aptos Labs team to get the necessary access.

Making a Release

1. Make your code changes

2. Create a changeset:

pnpm changeset

This will prompt you to:

• Select the packages that have changed
• Choose the type of version bump (patch, minor, or major)
• Write a description of the changes

3. Build the package:

pnpm build

4. Update versions:

pnpm changeset version

5. Publish:

pnpm changeset publish

Versioning

The package follows semantic versioning (MAJOR.MINOR.PATCH):

• MAJOR: Breaking changes
• MINOR: New features (backwards compatible)
• PATCH: Bug fixes (backwards compatible)

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

Apache-2.0 © Aptos Labs