Installation

Prerequisites#

• Next.js 14+ (App Router)
• React 18+
• TypeScript (recommended)

Install the Package#

Or with other package managers:

Optional Peer Dependencies#

If you plan to use the client-side features (AuthProvider, useAuth hook), you'll also need SWR:

If you need internationalization support:

Environment Setup#

Create or update your .env.local file:

TypeScript Configuration#

The library ships with TypeScript definitions. No additional setup needed.

The client-side AuthProvider and useAuth are generic, so instead of augmenting a fixed type you pass your own user shape as a type parameter:

Verify Installation#

Create a simple test file to verify the installation:

Run it:

Next Steps#

• Quick Start - Set up your first proxy
• Configuration - Customize the behavior