world-id-nextauth-template

KO | EN

gitlite — search

#python #hacktoberfest #typescript #llm #golang #machine-learning #deep-learning #linux #macos #java #awesome-list #vue #mcp #openai

world-id-nextauth-template

(★ 82)

Template repository for an app using NextAuth with Sign In with Worldcoin for user authentication.

world-id-nextauth-template Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Sign In with Worldcoin using NextAuth.js

## Overview

NextAuth.js is a complete open-source authentication solution.

This is an example application that shows how `next-auth` can be used to implement Sign In with Worldcoin.

Go to [NextAuth's documentation](https://next-auth.js.org) and [Worldcoin's Sign In documentation](https://docs.worldcoin.org/quick-start/sign-in) for more information and documentation.

## Getting Started

### 1. Create the repository from the template and install dependencies

Click the "Use this Template" button to create a new repository from this template.

```
git clone your_repo_url
cd your_repo_name
pnpm i
```

### 2. Configure your app in the Worldcoin Developer Portal

Create a new application in the [Worldcoin Developer Portal](https://developer.worldcoin.org/). Staging apps must use the [Worldcoin Simulator](https://simulator.worldcoin.org) for authentication, whereas production apps will use the [World App](https://worldcoin.org/download).

Add your callback URLs:
  - (staging apps only) `http://localhost:3000/api/auth/callback/worldcoin`
  - `https://your-app-url.com/api/auth/callback/worldcoin`

Note your Client ID and Client Secret for the next step.

### 3. Configure your local environment

Copy the .env.example file in this directory to .env.local (which will be ignored by Git):

```
cp .env.example .env.local
```

Add details for your Worldcoin application to the `.env.local` file. Get your Client ID and Client Secret from the [Worldcoin Developer Portal](https://developer.worldcoin.org/).

### 3. (Optional) Configure Additional Authentication Providers

Worldcoin's provider is pre-configured in this template. If you wish to add more providers, change line 33 of `components/header.tsx` to `signIn()` to allow users to choose their provider from a list and follow the steps below.

1. Review and update options in `pages/api/auth/[...nextauth].js` as needed.

2. When setting up OAuth, in the developer admin page for each of your OAuth services, you should configure the callback URL to use a callback path of `{server}/api/auth/callback/{provider}`.

e.g. For Google OAuth you would use: `http://localhost:3000/api/auth/callback/google`

A list of configured providers and their callback URLs is available from the endpoint `/api/auth/providers`. You can find more information at https://next-auth.js.org/configuration/providers/oauth

3. You can also choose to specify an SMTP server for passwordless sign in via email.

#### Database

A database may be needed needed to persist user accounts and to support email sign in when adding extra providers. However, you can still use NextAuth.js for authentication without a database by using OAuth for authentication. If you do not specify a database, [JSON Web Tokens](https://jwt.io/introduction) will be enabled by default.

You **can** skip configuring a database and come back to it later if you want.

For more information about setting up a database, please check out the following links:

- Docs: [next-auth.js.org/adapters/overview](https://next-auth.js.org/adapters/overview)

### 4. Start the application

To run your site locally, use:

```
pnpm run dev
```

To run it in production mode, use:

```
pnpm run build
pnpm run start
```

### 5. Preparing for Production

Follow the [Deployment documentation](https://authjs.dev/guides/basics/deployment) or deploy the example instantly using [Vercel](https://vercel.com). Ensure you set your environment variables in your production environment as well.

world-id-nextauth-template

world-id-nextauth-template Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

world-id-nextauth-template

world-id-nextauth-template Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README