Installation

Install FF packages for your TypeScript project

Overview

FF is distributed as three separate npm packages that you can install independently based on your needs:

• ff-effect: Effect.ts wrappers for AI SDK, Drizzle ORM, Inngest, and oRPC
• ff-ai: AI conversation management and message persistence
• ff-serv: HTTP server utilities, logging, and caching

All packages require Effect.ts as a peer dependency.

Prerequisites

Before installing FF, ensure you have:

• Node.js 18+ or Bun 1.0+ (FF is built with Bun but works with Node.js)
• TypeScript 5.0+ for full type safety
• Effect.ts 3.19+ as the foundational library

Installing ff-effect

The ff-effect package provides Effect.ts wrappers for popular libraries.

npm

npm install ff-effect effect

Peer Dependencies

Depending on which features you use, install the corresponding peer dependencies:

AI SDK

For ff-effect/for/ai wrappers:

npm

npm install ai

Drizzle ORM

For ff-effect/for/drizzle wrappers:

npm

npm install drizzle-orm

Inngest

For ff-effect/for/inngest wrappers:

npm

npm install inngest

oRPC

For ff-effect/for/orpc wrappers:

npm

npm install @orpc/server @orpc/contract

Installing ff-ai

The ff-ai package provides AI conversation management and message persistence.

npm

npm install ff-ai effect @effect/platform ai valibot

Drizzle Provider

To use the Drizzle message storage provider:

npm

npm install drizzle-orm postgres

The Drizzle provider for ff-ai is exported from ff-ai/providers/drizzle and requires Drizzle ORM and a PostgreSQL client.

Installing ff-serv

The ff-serv package provides HTTP server utilities, logging, and caching.

npm

npm install ff-serv effect @effect/opentelemetry get-port

Optional Dependencies

oRPC Integration

For oRPC HTTP handlers:

npm

npm install @orpc/server

Redis Caching

For Redis caching with ioredis:

npm

npm install ioredis

Access via ff-serv/cache/ioredis

Bun Redis

For Bun’s native Redis support:

No additional installation needed - included with Bun runtime.

Access via ff-serv/cache/bun-redis

Complete Installation

To install all three packages with their core dependencies:

npm

npm install ff-effect ff-ai ff-serv effect @effect/platform @effect/opentelemetry ai drizzle-orm valibot get-port

TypeScript Configuration

Ensure your tsconfig.json has strict mode enabled for the best type safety:

tsconfig.json

{
  "compilerOptions": {
    "strict": true,
    "moduleResolution": "bundler",
    "module": "ESNext",
    "target": "ES2022",
    "lib": ["ES2022"],
    "skipLibCheck": true,
    "esModuleInterop": true
  }
}

Verify Installation

Create a simple test file to verify your installation:

test.ts

import { Effect } from 'effect';
import { runPromiseUnwrapped } from 'ff-effect';

const program = Effect.gen(function* () {
  yield* Effect.log('FF is installed correctly!');
  return 'Success';
});

await runPromiseUnwrapped(program);

Run with:

node

npx tsx test.ts

You should see the log message and no errors.

Next Steps

Now that you have FF installed, check out the quickstart guide to build your first application, or explore the individual package documentation:

ff-effect

Explore AI SDK, Drizzle, and Inngest wrappers

ff-ai

Build conversation-based AI applications

ff-serv

Create HTTP services with Effect.ts