Skip to content

ScrapeGraphAI/BrainCraft

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BrainCraft Logo

BrainCraft

🧠 Your Personal Brainstorming & Diagramming AI Agent

License: MIT Node.js Version Python Version Docker

Transform your ideas into visual diagrams through natural conversation - both text and voice! 🎯

🌟 Features

  • 🤖 AI-Powered Brainstorming - Collaborate with an intelligent AI agent to explore and refine your ideas
  • 🗣️ Voice Interaction - Hands-free brainstorming with voice commands and AI vocal responses
  • 📊 Real-time Diagramming - Watch your ideas transform into diagrams as you speak or type
  • 🔄 Interactive Refinement - Instantly update diagrams through natural conversation
  • 📝 Multiple Diagram Types - Support for flowcharts, sequence diagrams, class diagrams, and more
  • 🎨 Modern UI/UX - Sleek, intuitive interface with customizable themes
  • Real-time Updates - See your diagrams evolve instantly as you brainstorm

🎬 Demo

Watch BrainCraft in action:

BrainCraft Demo

🚀 Getting Started

Prerequisites

  • Node.js (v16 or higher)
  • Python (3.10 or higher)
  • npm or yarn package manager
  • Docker and Docker Compose (for containerized setup)

🐳 Option 1: Docker Setup (Recommended)

  1. Configure environment files:
# Set up backend environment
cp backend/.env.example backend/.env
# Edit backend/.env and add your API keys:
# - MISTRAL_API_KEY (required for AI processing)
# - OPENAI_API_KEY (optional for additional AI capabilities)
# - LMNT_API_KEY (required for voice features)

# Set up frontend environment
cp frontend/.env.local.example frontend/.env.local
  1. Launch with Docker Compose:
docker compose -f docker/docker-compose.yml up

🌐 Access the application:

To stop:

docker compose -f docker/docker-compose.yml down

💻 Option 2: Local Setup

Frontend Setup

cd frontend
npm install
cp .env.local.example .env.local
npm run dev

Backend Setup

cd backend
uv sync
cp .env.example .env
# Configure API keys in .env:
# - MISTRAL_API_KEY: For AI processing
# - LMNT_API_KEY: For voice features

uv run uvicorn src.main:app --reload --port 8000

🎯 Usage

  1. 🌐 Open BrainCraft in your browser at http://localhost:3000
  2. 🎤 Choose between voice or text input mode
  3. 🗣️ Start brainstorming! Describe your ideas naturally
  4. 📊 Watch as your thoughts transform into professional diagrams
  5. 🔄 Refine the diagrams through conversation
  6. 🎨 Customize the appearance to match your preferences

🛠️ Technology Stack

  • Frontend: Next.js, TypeScript, Mermaid.js for diagramming
  • Backend: FastAPI, Mistral AI for LLM, LMNT for voice synthesis, OpenAI Whisper for voice transcription and Langchain for agentic workflow
  • Containerization: Docker & Docker Compose

🏆 Hackathon Submission

This project was created as part of the Tech: Berlin hackathon. We aimed to revolutionize the way people brainstorm and visualize their ideas by combining the power of AI, voice interaction, and real-time diagramming. Our solution enables a more natural and intuitive way to create and refine diagrams, making the brainstorming process more efficient and enjoyable.

🤝 Contributing

We welcome contributions! Here's how you can help:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

BrainCraft is open-source software licensed under the BSD-3-Clause License. See the LICENSE file for details.


Made with ❤️ by ScrapegraphAI

About

Diagram on the fly creator powered by AI agents

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •