Skip to content

IQAIcom/brain-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b0fb6e0 Β· Mar 18, 2025

History

9 Commits
Mar 17, 2025
Feb 27, 2025
Feb 27, 2025
Feb 27, 2025
Feb 27, 2025
Mar 18, 2025
Mar 18, 2025
Feb 27, 2025

Repository files navigation

🧠 Brain Starter

A simple starter template to build intelligent agents with the Brain Framework.

πŸš€ Overview

This repository contains everything you need to get started with Brain Framework - a powerful platform for building AI agents. Brain Framework makes it easy to create, test, and deploy intelligent agents across various interfaces.

⚑ Installation

Clone this repository and install dependencies:

git clone https://github.com/yourusername/my-brain-agent.git
cd my-brain-agent
pnpm install

πŸ“‹ Project Structure

my-brain-agent/
β”œβ”€β”€ src/           # Source code
β”œβ”€β”€ data/          # Data storage for your agent
β”œβ”€β”€ .env           # Environment variables
└── package.json   # Project dependencies

πŸ”§ Configuration

  1. Create a .env file in the project root:
OPENAI_API_KEY=your_openai_api_key_here

πŸƒβ€β™‚οΈ Running Your Agent

pnpm dev

🐳 Docker

This project includes Docker support for easy deployment and consistent environments.

Building the Docker Image

docker build -t my-brain-agent .

Running the Docker Container

docker run -p 3000:3000 --env-file .env my-brain-agent

The Dockerfile uses:

  • Node.js 23 for modern JavaScript support
  • pnpm for efficient dependency management
  • Proper layer caching to optimize build times
  • Automatic data directory creation for SQLite storage

This containerized setup ensures your brain agent runs in a consistent environment regardless of the host system.

πŸ“š Documentation

For more information about Brain Framework, check out the official documentation: Brain Framework Documentation