Skip to Content
Getting StartedInstallation

Installation

This guide will walk you through the necessary steps to get ygo-ruling-ai-chatbot set up on your local machine.


Prerequisites

  • OpenAI Account: You’ll need an API key for generating embeddings and using AI models. Ensure your account has sufficient credits (at least a dollar to run the app). Sign up or log in at https://openai.com/.
  • Pinecone Account: You’ll need access to a Pinecone vector database instance. The free trial is sufficient for getting started. Sign up or log in at https://www.pinecone.io/.
  • Git: For cloning the bot’s repository (installation guide).
  • Docker: You will need either Docker Desktop (for Windows or macOS) or Docker Engine (for Linux).
  • Docker Compose: This is typically installed alongside Docker Desktop or can be installed separately for Docker Engine (installation guide).

Cloning the Repository

Once you have the prerequisites installed, you can clone the ygo-ruling-ai-chatbot repository from GitHub.

  1. Open your terminal or command prompt.

  2. Navigate to the directory where you want to store the project files.

  3. Run the following command:

    git clone https://github.com/nedhmn/ygo-ruling-ai-chatbot.git
  4. Navigate into the cloned directory:

    cd ygo-ruling-ai-chatbot

You have now successfully installed the prerequisites and obtained the project files. The next step is to configure the project with your OpenAI and Pinecone details, along with other settings.

Last updated on