Skip to content
LiveFolioLiveFoliodocs
Back

Quickstart

Clone, install, configure, and run LiveFolio OSS on your local machine in under 5 minutes.

Prerequisites

  • Node.js 18+ (recommended: 20 LTS)
  • npm 9+
  • Git

Installation

# Clone the repository
git clone https://github.com/livefolio/oss-core
cd oss-core

# Install dependencies
npm install

# Copy and configure environment
cp .env.example .env

Configuration

Edit .env with your settings. Minimum required:

# Required: at least one AI provider key
GEMINI_API_KEY=your_gemini_api_key_here

# Optional: MCP security key
LiveFolio_API_KEY=your_secret_key_here

# Default: OSS mode (no change needed)
NEXT_PUBLIC_APP_ENV=oss

See Configuration for all available options.

Run

# Development
npm run dev

The server starts at http://localhost:3000.

Production Build

npm run build
npm start

The production server runs on port 3000 (configurable via PORT).

Verify Installation

# Check the dashboard renders
curl -s http://localhost:3000/dashboard | head -5

# Check the MCP endpoint
curl -s http://localhost:3000/api/mcp

# List API routes
curl -s http://localhost:3000/api/files

Next Steps