Cloning the Repository
To begin using RoboTalk, the first step is to clone the repository from GitHub onto your local machine. This process involves downloading all the necessary files and dependencies required to run the application. Here's a step-by-step guide:
- Open a Terminal: Launch your preferred terminal application.
- Navigate to the desired directory: Use the
cd
command to navigate to the directory where you want to clone the RoboTalk repository.
- Clone the repository: Enter the following command and press Enter:
git clone https://github.com/ZoneSixGames/RoboTalk.git
This command will download the RoboTalk repository into a new folder named 'RoboTalk' within your current directory.
Once the cloning process is complete, you'll have a local copy of the RoboTalk application, ready for further setup and configuration.
Installing Dependencies
After cloning the RoboTalk repository, the next step is to install the required dependencies. These are external libraries and packages that RoboTalk relies on to function correctly. To install the dependencies, follow these steps:
- Navigate to the RoboTalk directory: In your terminal, use the
cd
command to navigate into the 'RoboTalk' directory that was created during the cloning process:
cd RoboTalk
- Install the dependencies: Run the following command to install the dependencies specified in the
requirements.txt
file:
pip install -r requirements.txt
This command uses pip
, the Python Package installer, to automatically download and install all the necessary libraries. Ensure you have Python and pip
installed on your system before running this command.
Once the installation is complete, RoboTalk will have all the necessary dependencies to run successfully.
Updating the template.env File
The .env
file is used to store environment variables, such as API keys, that RoboTalk needs to access external services. To set up the .env
file, follow these steps:
- Rename
template.env
: Rename the template.env
file to .env
. This file is typically hidden by default, so ensure your file explorer is set to show Hidden files.
- Open the
.env
file: Use a text editor to open the .env
file.
- Add API Keys: Fill in the required API keys for Google Search Engine, OpenAI, and ElevenLabs. You'll need to create accounts and obtain API keys from these services:
- Google API Key: Required for researching current events and news.
- OpenAI API Key: Used for news summarization and script creation.
- ElevenLabs API Key: Needed for voice generation.
Replace the placeholder values in the .env
file with your actual API keys. Ensure the keys are correctly formatted and do not contain any extra spaces or characters.
By updating the .env
file with your API keys, you'll grant RoboTalk access to the necessary services and enable it to perform its core functions.
Running RoboTalk
With all the necessary setup complete, you're now ready to run the RoboTalk application. Here's how to do it:
- Open a Terminal: Launch your preferred terminal application.
- Navigate to the RoboTalk directory: Use the
cd
command to navigate into the 'RoboTalk' directory where you cloned the repository.
- Run the application: Enter the following command and press Enter:
streamlit run robotalk.py
This command uses Streamlit, a Python library for creating web applications, to launch the RoboTalk interface in your default web browser.
If the application does not automatically open in a new browser tab, you can manually access it by navigating to the URL provided in the terminal output. This URL is typically http://localhost:8501
.
Once the application is running, you'll see the RoboTalk interface, where you can enter your podcast topic, host name, and other Relevant details to start creating content.