Skip to content

Latest commit

 

History

History
104 lines (65 loc) · 3.11 KB

README.md

File metadata and controls

104 lines (65 loc) · 3.11 KB
Raw

Integrating Passkey Authentication in a Next.js App using NextAuth and Hanko Passkey API

This repository demonstrates how to add passkey login functionality to your Next.js app using NextAuth and Hanko Passkey API. Passkey authentication is a secure and user-friendly alternative to traditional password-based authentication, providing a seamless login experience for users.

For a detailed tutorial on implementing passkey login in your Next.js app using NextAuth, refer to our blog post: Add passkeys to your Next.js app using NextAuth

Passkey demo

Prerequisites

Before you begin, ensure you have the following:

  • Node.js installed (version 20.0.0 or later)
  • Hanko Passkey API key and tenant ID from Hanko Cloud
  • Resend API key from Resend
  • DB URL. In this case we are using Supabase

Technologies used

Note: You'll need to create a Passkey Project on Hanko Cloud with the App URL http://localhost:3000. See our docs to learn how to setup a passkey project.

Getting started

  1. Clone the repository
git clone https://github.com/teamhanko/passkeys-next-auth-starter.git

  1. Set up environment variables

    • Create a .env file in the root directory and add the following environment variables:
    NEXTAUTH_SECRET=random-string
NEXTAUTH_URL=http://localhost:3000

GITHUB_ID=
GITHUB_SECRET_ID=

# for email service
EMAIL_SERVER_USER=resend
EMAIL_SERVER_PASSWORD=your-resend-api-key
EMAIL_SERVER_HOST=smtp.resend.com
EMAIL_SERVER_PORT=465
[email protected]

DATABASE_URL=your-db-url

PASSKEYS_API_KEY=your-hanko-passkey-api-key
NEXT_PUBLIC_PASSKEYS_TENANT_ID=your-hanko-passkey-tenant-id
    • Replace your-hanko-passkey-api-key and your-hanko-passkey-tenant-id with your actual Hanko Passkey API key and tenant ID.

  2. Install the dependencies using your preferred package manager (e.g., npm, pnpm, yarn, or bun). For this project, we've used pnpm:

pnpm install
  1. Start the development server:
pnpm dev

Usage

  1. Start the application:

    • Access the application by navigating to http://localhost:3000 in your web browser.

  2. Sign up using email or GitHub.

  3. Register a passkey:

    • After logging in, register a passkey for the logged-in user.

  4. Log out:

    • After the passkey registration is successful, log out of the application.

  5. Login with with a passkey

    • On the login page, choose sign in with a passkey option to authenticate using a passkey.

Support

Feel free to reach out to us on Discord if you get into any issues.

License

This project is licensed under the MIT License.