Installing Brilliance Engine

Get up and running with Brilliance Engine in minutes.

Prerequisites

Before installing Brilliance Engine, ensure you have:

• Node.js 18.0 or higher
• npm or yarn package manager
• PostgreSQL 14+ (for data persistence)
• Redis 6+ (for real-time features)

Installation Methods

Method 1: npm (Recommended)

# Install globally
npm install -g @brilliance/engine-cli

# Or add to your project
npm install @brilliance/engine

Method 2: Docker

# Pull the official image
docker pull brilliance/engine:latest

# Run with default settings
docker run -p 3000:3000 brilliance/engine

Method 3: From Source

# Clone the repository
git clone https://github.com/SuperDuperDave/brilliance-engine.git
cd brilliance-engine

# Install dependencies
npm install

# Build the project
npm run build

# Start the engine
npm start

Configuration

Basic Configuration

Create a .env file in your project root:

# Core Settings
BE_PORT=3000
BE_ENV=production

# Database
DATABASE_URL=postgresql://user:pass@localhost:5432/brilliance

# Redis
REDIS_URL=redis://localhost:6379

# AI Providers
OPENAI_API_KEY=your-key-here
ANTHROPIC_API_KEY=your-key-here

# Security
JWT_SECRET=your-secret-key
SESSION_SECRET=your-session-secret

Advanced Configuration

For enterprise deployments, create brilliance.config.js:

module.exports = {
  server: {
    port: process.env.PORT || 3000,
    cluster: true,
    workers: 4
  },
  
  ai: {
    providers: ['openai', 'anthropic', 'local'],
    defaultModel: 'gpt-4',
    contextWindow: 128000,
    temperature: 0.7
  },
  
  features: {
    realTimeSync: true,
    persistence: true,
    analytics: true,
    collaboration: true
  },
  
  security: {
    rateLimit: {
      windowMs: 15 * 60 * 1000,
      max: 100
    },
    cors: {
      origin: ['https://yourdomain.com']
    }
  }
};

Verify Installation

Run the diagnostic command:

brilliance doctor

# Expected output:
✓ Node.js version: 18.17.0
✓ Database connection: OK
✓ Redis connection: OK
✓ AI providers: Connected
✓ Configuration: Valid
✓ Dependencies: Installed

Brilliance Engine is ready to use!

Quick Start

Create your first Brilliance Engine app:

# Create new project
brilliance create my-app

# Navigate to project
cd my-app

# Start development server
npm run dev

Visit http://localhost:3000 to see your app running.

Next Steps

• Follow the Quick Start Tutorial
• Explore Example Projects
• Read about Core Concepts
• Join our Discord Community

Troubleshooting

Common Issues

Port Already in Use

# Change port in .env
BE_PORT=3001

Database Connection Failed

• Ensure PostgreSQL is running
• Check DATABASE_URL format
• Verify credentials

AI Provider Errors

• Verify API keys are correct
• Check rate limits
• Ensure network connectivity

For more help, see our Troubleshooting Guide.