Vuer Auth
DocsChangelogBlogsAPI Reference

Installation

Get started with Vuer Auth Client by installing the package and its peer dependencies.

Prerequisites

Before installing Vuer Auth Client, ensure you have:

  • React >= 18.0.0
  • Node.js >= 16.0.0

Package Installation

Install the Vuer Auth Client package along with its required peer dependency:

Using pnpm (recommended)

pnpm add @vuer-ai/vuer-auth-client zustand

Using npm

npm install @vuer-ai/vuer-auth-client zustand

Using yarn

yarn add @vuer-ai/vuer-auth-client zustand

Peer Dependencies

The package requires the following peer dependencies:

  • zustand ^5.0.0 - State management library for React hooks
  • react >= 18.0.0 - Already included in your React project

Environment Configuration

After installation, configure your environment variables for the auth client:

# .env or .env.local
VITE_API_BASE_URL=https://your-auth-server.com
VITE_CLIENT_ID=your-client-id

Note: The environment variable prefix may vary depending on your build tool (e.g., VITE_ for Vite, NEXT_PUBLIC_ for Next.js, REACT_APP_ for Create React App).

Next Steps

After installation, you're ready to create an auth client instance and start using authentication in your application.

See Basic Usage to learn how to set up and use the auth client.