Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement: Add Voice Command Functionality and Enable Bot Speech #5

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
@@ -1 +1 @@
REACT_APP_API_URL=https://us-east1-chat-agents.cloudfunctions.net/bot-backend
REACT_APP_API_URL=http://localhost:3000
59 changes: 54 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,55 @@
## Textbase Bot UI repo
# Textbase Bot UI

## Project Overview
This repository contains the user interface (UI) for the Textbase Bot project. Textbase Bot is an innovative chatbot that can understand and respond to text-based queries. The UI serves as the frontend for interacting with the bot.

## Setup Instructions

### Prerequisites
- Node.js installed on your local machine.

### Installation
1. Clone this repository to your local machine using the following command:
```shell
git clone [email protected]:alex8430/textbase-bot.git

## Setup Instructions

### Prerequisites
- Node.js installed on your local machine.

### Installation

1. **Install Dependency:**
```shell
cd textbase-bot
npm install

2. **Running Locally:**
```shell
npm start

### Chat Bot Backend

1. Clone the backend repository to your local machine using the following command:
```sell
git clone [email protected]:alex8430/chat-bot-backend.git
2. pass backend endpoint in query params
```sell
?API_URL=http://localhost:<port>

## Screenshots

**Screenshot 1:**
![Screenshot 1](./public/demo.png)
*Walkthrough of UI*
1. There is ... setting button when we click on that is dropdown open and there is a list of model that we get from backend we can switch our llm model
2. Mic button to start voice recognition to give command to bot.
3. Bot Voice. allow bot to speak it is a toggle button


## Demo Video

[Watch the Textbase Bot UI in action on YouTube](https://www.youtube.com/watch?v=gQNaDvKSldU)


### How to setup locally
1. `npm i`
2. `npm start`
3. Pass in query params `?API_URL=http://localhost:<port>` - This is the url of python backend
6 changes: 6 additions & 0 deletions global.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
declare global {
interface Window {
SpeechRecognition: typeof SpeechRecognition;
webkitSpeechRecognition: typeof SpeechRecognition;
}
}
Loading