ChatNav Project

LLM-powered chat overlay that can navigate and control any web page via natural language using a simple API key.

Table of Contents

• ChatNav Project
  • Table of Contents
  • Introduction
  • Features
  • Technologies Used
  • Getting Started
    • Installation
    • Usage
  • Development
  • Project Structure
  • Contributing
  • License

Introduction

ChatNav is a lightweight, embeddable chat overlay that gives users natural language control over any website. By integrating ChatNav with a simple API key, you can empower your users to navigate, interact with, and perform actions on your web pages just by typing commands.

This project is part of the FairIntellio ecosystem.

Features

(You can expand this section with key features)

• Natural Language Control: Navigate and interact with web pages using conversational commands.
• Easy Integration: Add chat-based navigation to your site with just a few lines of code.
• LLM-Powered: Leverages the power of large language models to understand user intent.
• Customizable: Easily extend and adapt to your specific needs.

Technologies Used

• TypeScript - A strongly typed superset of JavaScript.
• tsup - A fast and simple bundler for TypeScript libraries.

Getting Started

You can add ChatNav to your project via npm or by using a CDN.

Installation

npm install @your-scope/chatnav

Usage

You can import ChatNav and initialize it in your application's entry point.

import { ChatNav } from '@your-scope/chatnav';

const chatnav = new ChatNav({
  apiKey: 'YOUR_API_KEY_HERE'
});

chatnav.init();

This will typically open the application in your browser at http://localhost:5173.

Project Structure

chatnav/
├── public/                 # Static assets
├── src/                    # Source code
│   ├── components/         # Reusable UI components
│   ├── pages/              # Application pages/routes
│   ├── hooks/              # Custom React hooks
│   ├── services/           # API integration, data fetching
│   ├── styles/             # Global styles
│   ├── utils/              # Utility functions
│   ├── App.tsx             # Main application component
│   └── main.tsx            # Entry point of the application
├── .eslintrc.cjs           # ESLint configuration
├── index.html              # Main HTML file
├── package.json            # Project dependencies and scripts
├── tailwind.config.js      # Tailwind CSS configuration
├── tsconfig.json           # TypeScript configuration
└── vite.config.ts          # Vite configuration

Deployment

(Please provide instructions on how to deploy this application.)

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Please see CONTRIBUTING.md for more details.

License

This project is licensed under the MIT License. See the LICENSE file for more details.