Installation Guide

Install ZKAuth

Choose your platform and get ZKAuth running in minutes with our comprehensive installation guides.

Choose Your Platform

Select your preferred programming language or framework

JavaScript/TypeScript

Node.js, React, Vue, Angular, and more

Python

Django, FastAPI, Flask, and more (SDK coming soon)

Go

High-performance Go applications (SDK coming soon)

Rust

Memory-safe systems programming (SDK coming soon)

React

React hooks and components

Vue.js

Vue 3 composition API

Installation Instructions

Follow these steps to install and configure ZKAuth

Installation

Install ZKAuth for JavaScript/TypeScript

bash

# npm
npm install your-zkauth-http-client

# yarn
yarn add your-zkauth-http-client

# pnpm
pnpm add your-zkauth-http-client

Basic Setup

Initialize ZKAuth in your JavaScript/TypeScript application

javascript

import { ZKAuthSDK } from 'your-zkauth-http-client';

const zkauth = new ZKAuthSDK({
  apiKey: process.env.ZKAUTH_API_KEY,
  baseUrl: process.env.ZKAUTH_BASE_URL || 'https://zkp-engine-main-1.vercel.app'
});

Framework Integrations

Seamless integration with popular frameworks

Next.js

Server-side rendering and API routes

javascript

// pages/api/auth/[...nextauth].js
import NextAuth from 'next-auth'
import { ZKAuthProvider } from './zkauth-next-helper'

export default NextAuth({
  providers: [
    ZKAuthProvider({
      clientId: process.env.ZKAUTH_CLIENT_ID,
      clientSecret: process.env.ZKAUTH_CLIENT_SECRET,
    }),
  ],
})

Express.js

Node.js web application framework

javascript

const express = require('express');
const { ZKAuthMiddleware } = require('./zkauth-node-helper');

const app = express();

// Initialize ZKAuth middleware
const zkAuth = new ZKAuthMiddleware({
  apiKey: process.env.ZKAUTH_API_KEY
});

// Protected route middleware
const requireAuth = zkAuth.authenticate();

app.get('/protected', requireAuth, (req, res) => {
  res.json({ user: req.user });
});

Django

Python web framework

python

# settings.py
INSTALLED_APPS = [
    # ...
    'zkauth',
]

ZKAUTH_API_KEY = 'zka_...'
ZKAUTH_BASE_URL = 'https://zkp-engine-main-1.vercel.app'

# views.py
from zkauth.decorators import zkauth_required

@require_zkauth_session
def protected_view(request):
    user = request.zkauth_user
    return JsonResponse({'user': user})

Environment Configuration

Set up your environment variables and configuration

Environment Variables

Configure your API keys and endpoints

bash

# Environment Variables (.env)
ZKAUTH_API_KEY=zka_live_your_api_key_here
ZKAUTH_BASE_URL=https://zkp-engine-main-1.vercel.app

# Development
ZKAUTH_API_KEY=zka_test_your_test_key_here

# Production
ZKAUTH_API_KEY=zka_live_your_production_key_here

What's Next?

Continue your journey with ZKAuth

Quick Start

Build your first authentication flow

Examples

Real-world integration examples

SDK Reference

Complete API documentation

Ready to Install?

Get started with ZKAuth today and build secure applications.