Skip to content

AJBrownson/mini-faq-bot

Repository files navigation

Mini-FAQ-BOT - An AI powered FAQ chatbot

Mini is an AI chatbot that reads business information stored in a markdown or json file (in this case, the information is about a fictional social media scheduling software called Teeweety). Mini utilizes CopilotKit to read the data given in order to be able to provide informed answers to users' queries about the software.

Table of Contents

Features

  • AI-powered answers to users' queries
  • Automation with CopilotKit

Demo

You can view a live demo of Mini-FAQ-BOT here

A youtube video demo of the bot is available here

Screenshots

Welcome Message Results Results

Technologies

Getting Started

To get started with the project, run the following commands in your terminal:

  1. Clone the repository
git clone https://github.com/AJBrownson/mini-faq-bot.git
cd mini-faq-bot
  1. Install the dependencies
npm install
  1. Create a .env file in the root directory and add the following environment variables:
GROQ_API_KEY=your_groq_api_key
GROQ_MODEL=llama3-8b-8192 or model-of-your-choice

You can get your GROQ API key by signing up on groq.dev

  1. Start the development server
npm run dev
  1. Open http://localhost:3000 in your browser to view the app

License

This project is licensed under the MIT License - see the LICENSE file for details

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

If you have any questions, feel free to reach out to me at Anietie Brownson.