KAIRA-AI

---

Product Video

output.1.mp4

---

Table of Contents

• Overview
• Features
• Project Structure
  • Project Index
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Testing
• Project Roadmap
• Contributing
• Acknowledgments

---

Overview

Kaira-AI: Mental Health Chatbot Kaira-AI is a mental health support chatbot designed to provide users with compassionate, confidential, and accessible assistance for mental well-being. Built using advanced AI technologies, Kaira offers a safe space for users to talk, express their feelings, and receive guidance on managing stress, anxiety, depression, and other emotional challenges. Kaira is not a replacement for professional therapy but aims to provide immediate support and resources, helping users manage their mental health in a private and empathetic manner.

---

Features

Conversational Support: Kaira engages in open-ended conversations, offering a friendly, non-judgmental environment for users to talk about their mental health concerns.

Speech-to-Text (STT): Users can speak directly to Kaira, and it will transcribe their speech into text for real-time processing and response. This feature enables hands-free interaction for users who prefer talking over typing.

Text-to-Speech (TTS): Kaira can also speak its responses aloud, providing a voice for the chatbot that allows users to listen to the support and guidance rather than reading it. This feature makes Kaira more accessible and interactive.

Also suggest some fun activities based on user interaction.

---

Project Structure

 Kaira-AI/
    README.md
    index.html
    package-lock.json
    package.json
    public
       vite.svg
    src
      App.jsx
      assets
      components
      config
      context
      index.css
      main.jsx
      vite.config.js

Project Index

KAIRA-AI/

__root__

package-lock.json

vite.config.js

package.json

index.html

src

index.css

App.jsx

main.jsx

config

aiConfig.js

gemini.js

deepgram.js

components

AIResponse.jsx

AudioRecorder

AudioRecorder.css

AudioRecorder.jsx

Main

Main.jsx

Main.css

TextToSpeech

TextToSpeech.jsx

TextToSpeech.css

Sidebar

Sidebar.jsx

Sidebar.css

context

Context.jsx

---

Getting Started

Prerequisites

Before getting started with Kaira-AI, ensure your runtime environment meets the following requirements:

• Programming Language: JavaScript
• Package Manager: Npm

Installation

Install Kaira-AI using one of the following methods:

Build from source:

1. Clone the Kaira-AI repository:

 git clone https://github.com/Ronit-Pai/Kaira-AI

2. Navigate to the project directory:

 cd Kaira-AI

3. Install the project dependencies:

Using npm  

 npm install

Usage

Run Kaira-AI using the following command: Using npm  

 npm start

Testing

Run the test suite using the following command: Using npm  

 npm test

Contributing

• Join the Discussions**: Share your insights, provide feedback, or ask questions.
• Report Issues**: Submit bugs found or log feature requests for the Kaira-AI project.
• Submit Pull Requests**: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/Ronit-Pai/Kaira-AI

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

Acknowledgments

• This project uses the Gemini AI model from Google
• Icons and assets from official gemini site
• This project uses the Deepgram API for the STT and TSS

Additional Information

• This project is being built for a hackathon conducted by Finite Loop Club , A coding club of NMAMIT.
• Name of the Hackathon is HACKLOOP(2024).
• Stay tuned for further Updates regarding our progress in the HACKLOOP.