Getting Started

This guide will help you set up the TKM AI Agency Platform for development.

Prerequisites

• Python 3.9+
• Node.js 18+
• Git

Initial Setup

1. Clone the Repository

   git clone https://github.com/Hovup-FO/tkm_ai_agency_platform.git
   cd tkm_ai_agency_platform

2. Environment Variables Create a .env file in the root directory:

   # API Keys
   GROQ_API_KEY=""
   TAVILY_API_KEY=""
   MODEL=""
   TOOLHOUSE_API_KEY=""
   
   # Database Configuration
   SINGLESTORE_HOST=""
   SINGLESTORE_PORT=""
   SINGLESTORE_USER=""
   SINGLESTORE_PASSWORD=""
   SINGLESTORE_DATABASE=""
   
   # Email Service
   MAILGUN_API_KEY=""
   MAILGUN_DOMAIN=""

Backend Setup

1. Create and activate virtual environment

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

2. Install dependencies

   cd Backend
   pip install -r requirements.txt

3. Start Backend Server

   uvicorn main:app --reload

Frontend Setup

1. Install dependencies

   cd Frontend
   npm install

2. Start Frontend Development Server

   npm run dev

Verify Installation

Once both servers are running, you can access:

• Backend API: http://localhost:8000 (opens in a new tab)
• API Documentation: http://docs.tkm.technology (opens in a new tab)
• Frontend: http://localhost:3000 (opens in a new tab)

Next Steps

1. Review the API documentation to understand available endpoints
2. Explore the Backend section to learn about the agent architecture
3. Check the Frontend section for UI components and features
4. Visit the API Reference for detailed endpoint specifications