🍣 Uma Chatbot for food

This UMA chatbot uses Dialogflow Natural Language Processing (NLP) to manage orders, add/remove items, complete orders, and track status in real-time for efficient ordering.

Deployed App: Uma Bot

📂 Project Structure

uma_food_chatbot/

• app/: Main application code.
  • main.py: FastAPI app instance and endpoint handlers.
  • db_helper.py: Database helper functions for interacting with the database.
  • generic_helper.py: Generic helper functions used across the application..
  • static/: Static files (CSS and images).
  • templates/: HTML files.
• setup/: Setup documentation (DiaogFlow, ngrok, and sql).
• run.py: Entry point for running the FastAPI application using Uvicorn.
• README.md: Project overview, setup instructions, and usage information.

🛠️ Setup

📚 Prerequisites

• Python 3.7 or higher
• Proficiency in Python programming
• Familiarity with FastAPI
• Basic knowledge of MySQL
• Understanding of Dialogflow and handling JSON data

📥 Installation

1. Clone the repository:

   git clone https://github.com/lisek75/uma_food_chatbot.git
   cd uma_food_chatbot

2. Create and activate a virtual environment:

   python -m venv .venv
   .venv\Scripts\activate  # On Windows
   source .venv/bin/activate  # On MacOS/Linux

3. Install the dependencies:

   pip install -r requirements.txt

🗄️MySQL Setup

1. Install MySQL:

   Download and install MySQL from the official website.

   • MySQL Workbench is included in the installer package.
   • Alternatively, use another client for database management (e.g.,phpMyAdmin, HeidiSQL...)

2. Configure and Import Database Schema:

   • Rename .env.example to .env and update the environment variables with your configuration.
   • Import uma_food_chatbot.sql from the setup folder using the client's import feature.

🚀 Running the Application

1. Start the FastAPI application:

   python run.py

   The application will be available at http://127.0.0.1:<port>, where <port> is the port number you specified (e.g., 8000).

2. Install and setup Dialogflow and ngrok:

   Refer to the setup/dialogflow and setup/ngrok_setup.md for detailed instructions on setting up Dialogflow and ngrok.

3. Run ngrok: Use this if you are running the application locally and do not have HTTPS.

   ngrok http --domain=your-custom-domain.ngrok-free.app 8000

4. Access the application:

   If you run the app locally, go to http://127.0.0.1:<port>, for example: http://127.0.0.1:8000.

💻 Usage

• The application serves static files like CSS and images.
• It renders the index.html template, which includes an embedded chatbot iframe.
• Users can interact with the chatbot to add or remove items, complete their orders, and track their order status.