Installation

This guide covers how to install Flowfull Client in your project.

NPM

Install using npm:

npm install @pubflow/flowfull-client

Yarn

Install using Yarn:

yarn add @pubflow/flowfull-client

PNPM

Install using pnpm:

pnpm add @pubflow/flowfull-client

Bun

Install using Bun:

bun add @pubflow/flowfull-client

Platform Requirements

Flowfull Client works in all JavaScript environments:

Platform	Supported	Notes
React	✅ Yes	Vite, Create React App, etc.
React Native	✅ Yes	Expo, bare React Native
Next.js	✅ Yes	App Router, Pages Router, Server Components
Node.js	✅ Yes	Version 18+
Bun	✅ Yes	All versions
Browser	✅ Yes	All modern browsers

Dependencies

Flowfull Client has zero dependencies! It's a standalone package that works out of the box.

TypeScript

Flowfull Client is written in TypeScript and includes type definitions. No additional @types packages are needed.

import { createFlowfull } from '@pubflow/flowfull-client';

const api = createFlowfull('https://api.example.com');
// Full TypeScript support!

React Native Setup

For React Native, you need to install @react-native-async-storage/async-storage for session storage:

npm install @react-native-async-storage/async-storage

Then configure it in your app:

// app.json or app.config.js
{
  "expo": {
    "plugins": [
      "@react-native-async-storage/async-storage"
    ]
  }
}

Next Steps

Now that you have Flowfull Client installed, check out:

• Getting Started - Quick start guide
• Authentication - Learn how to handle authentication
• Making API Calls - Explore all HTTP methods

Troubleshooting

Module not found

If you get a "module not found" error, make sure you've installed the package:

npm install @pubflow/flowfull-client

TypeScript errors

If you get TypeScript errors, make sure your tsconfig.json includes:

{
  "compilerOptions": {
    "moduleResolution": "node",
    "esModuleInterop": true
  }
}

React Native AsyncStorage error

If you get an AsyncStorage error in React Native, install the package:

npm install @react-native-async-storage/async-storage

Version Compatibility

Flowfull Client	Node.js	React	React Native	Next.js
1.x	18+	16.8+	0.60+	13+

Need Help?

• 📚 Full Documentation - Complete package reference
• 💬 GitHub Discussions - Ask questions
• 🐛 Report Issues - Found a bug?