Skip to content

Installation ​

This guide covers how to install Flowfull Client packages for different frameworks.

React ​

For React applications (Create React App, Vite, TanStack Start, Remix, etc.):

bash
npm install @pubflow/core @pubflow/react swr

Or with yarn:

bash
yarn add @pubflow/core @pubflow/react swr

Or with pnpm:

bash
pnpm add @pubflow/core @pubflow/react swr

Dependencies ​

  • @pubflow/core - Core functionality (automatically included)
  • @pubflow/react - React hooks and components
  • swr - Data fetching and caching library

React Native (Expo) ​

For Expo projects (recommended):

bash
npx expo install @pubflow/core @pubflow/react-native swr @react-native-async-storage/async-storage expo-secure-store

Dependencies ​

  • @pubflow/core - Core functionality (automatically included)
  • @pubflow/react-native - React Native hooks and components
  • swr - Data fetching and caching library
  • @react-native-async-storage/async-storage - AsyncStorage for data persistence
  • expo-secure-store - Secure storage for sensitive data (tokens, sessions)

React Native (Bare) ​

For bare React Native projects:

bash
npm install @pubflow/core @pubflow/react-native swr
npm install @react-native-async-storage/async-storage

WARNING

Expo SecureStore is not available in bare React Native. The package will automatically fall back to AsyncStorage.

Next.js ​

For Next.js applications (App Router or Pages Router):

bash
npm install @pubflow/core @pubflow/nextjs swr

Dependencies ​

  • @pubflow/core - Core functionality (automatically included)
  • @pubflow/nextjs - Next.js SSR utilities and API middleware
  • swr - Data fetching and caching library

Verification ​

After installation, verify that the packages are installed correctly:

bash
npm list @pubflow/react
# or
npm list @pubflow/react-native
# or
npm list @pubflow/nextjs

TypeScript Support ​

All Flowfull Client packages include TypeScript definitions out of the box. No additional @types packages are needed.

Next Steps ​