Documentation

Everything you need to build and deploy AI apps with KiroCore

📖 About KiroCore

KiroCore is a universal AI agent platform that transforms a single codebase into multiple specialized applications through simple configuration files.

🎯

One Codebase

Build once, deploy unlimited AI applications

⚡

Config-Driven

New apps in 5 minutes with simple config files

🤖

Real AI

💡 Problem & Solution

❌The Problem

Building AI apps is repetitive

•Rebuild frontend for every new AI app
•Duplicate backend API routes
•Recreate chat interfaces repeatedly
•Waste weeks on boilerplate code

✅Our Solution

KiroCore changes everything

•One reusable codebase for all apps
•Just change config to create new apps
•UI and backend stay the same
•Launch apps in minutes, not weeks

🚀 Getting Started

Get KiroCore running in 3 minutes with these simple steps.

Install Dependencies

npm install

Set Up Gemini API

Get your free API key from Google AI Studio

Add to server/.env:

GEMINI_API_KEY=your_api_key_here

Run the App

npm run dev

Open http://localhost:3000

✅ That's it! You're ready to go.

Try StudyBuddy at /study-buddy or IdeaForge at /idea-forge

📦 Installation

Prerequisites

✓Node.js 18+ installed
✓npm package manager
✓Google Gemini API key (free)

Environment Setup

Copy example files:

cp .env.example .env.localcp server/.env.example server/.env

Development Commands

npm run dev

Run both frontend and backend

npm run dev:frontend

Frontend only (port 3000)

npm run dev:backend

Backend only (port 3001)

🎮 How to Use

Using Existing Apps

📚 StudyBuddy

AI tutor for education and learning

/study-buddy

💡 IdeaForge

Creative brainstorming partner

/idea-forge

💻 CodeMentor

Programming tutor

/code-mentor

✍️ StoryWeaver

Creative writing companion

/story-weaver

Keyboard Shortcuts

New chatCtrl+N

Browse appsCtrl+B

Export PDFCtrl+E

Show shortcutsCtrl+/

✨ Creating New Apps

Add a new AI app in under 5 minutes with just a config file.

Step 1: Create App Directory

mkdir apps/my-app

Step 2: Create Config File

Create apps/my-app/agent.config.ts:

const config = {
  name: "MyApp",
  description: "My AI assistant",
  icon: "FiStar",
  systemPrompt: `You are a helpful AI assistant...`,
  welcomeMessage: "Hello! How can I help?",
  features: [
    "Feature 1",
    "Feature 2",
    "Feature 3"
  ],
  theme: {
    primary: "#8b5cf6",
    secondary: "#a78bfa",
    accent: "#7c3aed"
  }
};

export default config;

Step 3: Access Your App

Navigate to:

http://localhost:3000/my-app

💡 Pro Tip

The platform automatically discovers new apps. No need to restart the server or modify core code!

🎨 Features

💬

ChatGPT-Style Interface

Familiar, intuitive chat UI with conversation history and sidebar

📝

Markdown Rendering

Rich text with syntax highlighting and code block copy

⌨️

Keyboard Shortcuts

Power user features with Ctrl+N, Ctrl+B, Ctrl+E shortcuts

📄

PDF Export

Save conversations as PDF for offline reference

🎭

Unique Personalities

Each app has distinct AI behavior and tone

💾

Persistent History

Conversations saved in localStorage, survive page refresh

📚 API Reference

POST/api/chat

Send a message to the AI agent

Request Body:

{
  "message": "Explain React hooks",
  "appType": "study-buddy",
  "conversationHistory": [
    {
      "role": "user",
      "content": "Previous message",
      "timestamp": "2024-01-01T00:00:00Z"
    }
  ]
}

Response:

{
  "success": true,
  "response": "React hooks are functions...",
  "appType": "study-buddy",
  "timestamp": "2024-01-01T00:00:00Z",
  "source": "gemini-ai"
}

GET/api/apps

Get all available apps

Response:

{
  "apps": [
    {
      "id": "study-buddy",
      "name": "StudyBuddy",
      "description": "Your AI study companion",
      "icon": "FiBookOpen",
      "theme": {
        "primary": "#3b82f6",
        "secondary": "#60a5fa",
        "accent": "#93c5fd"
      },
      "features": ["Concept Explanations", "Problem Solving"]
    }
  ]
}

GET/api/apps/:appType

Get specific app configuration

Response:

{
  "config": {
    "id": "study-buddy",
    "name": "StudyBuddy",
    "systemPrompt": "You are an expert tutor...",
    "welcomeMessage": "Hi! I'm StudyBuddy...",
    "theme": { "primary": "#3b82f6" }
  }
}

🔧 Troubleshooting

Port Already in Use

If port 3000 or 3001 is already in use:

npx kill-port 3000

AI Not Responding

•Check server/.env has valid GEMINI_API_KEY
•Verify API key at Google AI Studio
•Check backend console for errors

App Not Loading

•Clear browser cache (Ctrl+Shift+R)
•Check console for errors (F12)
•Verify app config exists in apps/ directory

Build Fails

Clean install and rebuild:

rm -rf node_modules package-lock.jsonnpm installnpm run build

💡 Need More Help?

Check the GitHub repository for more documentation and examples.