Skip to content

setup.md

Latest commit

 

History

History
61 lines (46 loc) · 2.32 KB

setup.md

File metadata and controls

61 lines (46 loc) · 2.32 KB

🛠️ Knowl Setup & Installation Guide

Welcome to the future of conversational research. This guide will help you get your Knowl Voice Agents up and running on your local machine.

📌 Prerequisites

Before you begin, ensure you have the following installed:

🚀 Quick Start

1. Clone the Repository

git clone https://github.com/Shankar-105/knowl.git
cd knowl

2. Install Dependencies

npm install

3. Configure Environment Variables

Create a .env file in the root directory and add the following keys.

🎙️ Voice AI Configuration (Critical)

Variable Description Where to find
NEXT_PUBLIC_VAPI_PUBLIC_KEY Public key for Vapi.ai Vapi Dashboard
ELEVEN_LABS_API_KEY API key for high-fidelity voices ElevenLabs Profile

🧠 Brain & Database

Variable Description Where to find
GEMINI_API_KEY Powers AI research & synthesis Google AI Studio
MONGODB_URL Database for your research nodes MongoDB Atlas

🔐 Auth & Storage

Variable Description Where to find
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY Auth provider Clerk Dashboard
CLERK_SECRET_KEY Secret auth key Clerk Dashboard
BLOB_READ_WRITE_TOKEN For PDF & image storage Vercel Blob

4. Run the Development Server

npm run dev

Open http://localhost:3000 with your browser to start building.

🛠️ Troubleshooting

  • Voice Agent Not Connecting: Ensure your Vapi,ElevenLabs public key is correct
  • Microphone Permissions: Browsers often block mic access on non-HTTPS local dev environments. Use localhost or set up a local proxy if needed.
  • Database Errors: Verify that your MongoDB IP whitelist includes your current IP address.

Developed with ❤️ for the future of live research with voice agents.