Getting Started with AiVerse

Learn how to set up and configure AiVerse AI agent framework in just a few minutes.

Prerequisites
  • Required
    Node.js 18.0 or later
  • Required
    npm, yarn, or pnpm package manager
  • Optional
    Git for version control

1. Clone the Repository

Start by cloning the AiVerse repository to your local machine:

git clone https://github.com/yourusername/AiVerse.git
cd AiVerse

2. Install Dependencies

Install the required dependencies using your preferred package manager:

pnpm
pnpm install
npm
npm install
yarn
yarn install

3. Environment Configuration

Create a .env.local file in the root directory and add your API credentials:

# AI Model Configuration
GOOGLE_GENERATIVE_AI_API_KEY=your-google-generative-ai-api-key

# Search Tools
TAVILY_API_KEY=your-tavily-api-key
SERP_API_KEY=your-serp-api-key

# Authentication
GOOGLE_CLIENT_ID=your-google-oauth-client-id
GOOGLE_CLIENT_SECRET=your-google-oauth-client-secret
NEXTAUTH_SECRET=your-nextauth-secret
NEXTAUTH_URL=http://localhost:3000

# Additional Services
CORSEL_API_KEY=your-corsel-api-key
NEXT_PUBLIC_PINATA_API_KEY=your-pinata-api-key
NEXT_PUBLIC_PINATA_SECRET_API_KEY=your-pinata-api-secret

Note: You don't need all API keys to get started. AiVerse will work with whatever tools you configure.

4. Start the Development Server

Launch the development server to start using AiVerse:

npm run dev

Open http://localhost:3000 in your browser to access the AiVerse interface.

5. Create Your First Agent

Once AiVerse is running, you can create your first AI agent:

  1. Navigate to the agent creation interface
  2. Write a system prompt for your agent
  3. Select the tools you want your agent to have access to
  4. Start a conversation and watch your agent use tools dynamically
Installation Checklist
Repository cloned successfully
Dependencies installed
Environment variables configured
Development server running
First agent created