DialogflowCX Playbook Builder

This a helper tool created to streamline the process of creating Dialogflow CX Playbooks.

Requirements

• Python 3.10+ is required.
• Make sure you have make installed on your system for using the Makefile.

Setup Instructions

1. Clone the Repository

   git clone https://github.com/chandralegend/dialogflow-playbook-builder.git
   cd dialogflow-playbook-builder

2. Create Environment Variables File

   A sample environment variables file, .env.sample, is provided. Copy this file to create your own .env file:

   cp .env.sample .env

3. Update Environment Variables

   Open .env in a text editor and update the values as required for your environment.

4. Install Dependencies

   Use the Makefile to set up a Python virtual environment and install dependencies:

   make install

   This will:

   • Create a virtual environment in the .venv directory.
   • Install all required Python dependencies specified in requirements.txt.

5. Run the Application

   To start the Streamlit application with the environment variables loaded, use:

   make run

   This command will:

   • Load environment variables from .env.
   • Run the Streamlit application, which can be accessed at http://localhost:8501 by default.

6. Clean Up (Optional)

   If you need to remove the virtual environment, run:

   make clean

Additional Notes

• Ensure the .env file is never committed to version control as it contains sensitive information. The .env.sample file serves as a safe, shareable template.
• If any dependencies are added, update requirements.txt and re-run make install to ensure they are installed in the virtual environment.