Quick Start

This guide will help you get Folionaut running locally in a few minutes.

Prerequisites

• Node.js 18+ or Bun 1.0+
• Turso CLI (for database)
• Redis (optional, for distributed caching)

Installation

1. Clone the Repository

git clone https://github.com/spencerjireh/folionaut.git
cd folionaut

2. Install Dependencies

bun

bun install

npm

npm install

3. Set Up Database

Create a Turso database:

# Install Turso CLI if not already installed
curl -sSfL https://get.tur.so/install.sh | bash

# Create database
turso db create folionaut

# Get connection details
turso db show folionaut --url
turso db tokens create folionaut

4. Configure Environment

Copy the example environment file and update it:

cp .env.example .env

Edit .env with your values:

# Database
TURSO_DATABASE_URL=libsql://your-db.turso.io
TURSO_AUTH_TOKEN=your-token

# Admin API Key (generate a secure random string)
ADMIN_API_KEY=your-secure-key

# Optional: LLM Provider
LLM_API_KEY=your-openai-key

# Optional: Redis
REDIS_URL=redis://localhost:6379

5. Run Migrations

bun run db:migrate

6. Start the Server

Development

bun run dev

Production

bun run build
bun run start

The API will be available at http://localhost:3000.

Verify Installation

Health Check

curl http://localhost:3000/api/health/ready

Expected response:

{
  "status": "ready",
  "checks": {
    "database": "ok"
  }
}

Create Test Content

curl -X POST http://localhost:3000/api/v1/admin/content \
  -H "Content-Type: application/json" \
  -H "X-Admin-Key: your-secure-key" \
  -d '{
    "type": "project",
    "slug": "test-project",
    "data": {
      "title": "Test Project",
      "description": "A test project",
      "tags": ["test"],
      "featured": false
    },
    "status": "published"
  }'

TIP

The type field is not limited to a fixed set of values -- any lowercase alphanumeric string with hyphens works (e.g., blog-post, certification, testimonial). The data field accepts any JSON object, so you can structure your content however you like.

Fetch Content

curl http://localhost:3000/api/v1/content/bundle

Docker Setup

For a containerized setup:

# Build image
docker build -t folionaut .

# Run with environment variables
docker run -p 3000:3000 \
  -e TURSO_DATABASE_URL=... \
  -e TURSO_AUTH_TOKEN=... \
  -e ADMIN_API_KEY=... \
  folionaut

Or use Docker Compose:

docker-compose up

Next Steps

• Configuration - All environment variables
• API Reference - Full API documentation
• MCP Server - Set up AI integration