Stytch Next.js Page Router example application

Overview

This example application demonstrates how one may use Stytch within a Next.js application using the new Pages Router. If you'd like to see an App Router example, check out our Next.js App Router example.

This project uses Stytch's Next.js SDK which provides pre-built UI components, useful React hooks, headless methods to securely interact with Stytch, and is SSR friendly. This project also utilizes Stytch's Node Backend SDK for authenticating the logged in user's session.

We'd also recommend checking out our Next.js quickstart guide, which explains how to incorporate the Stytch authentication concepts demonstrated in this example app into your own Next.js application.

This application features Email Magic Links and Google OAuth authentication. You can use this application's source code as a learning resource, or use it as a jumping off point for your own project. We are excited to see what you build with Stytch!

Set up

Follow the steps below to get this application fully functional and running using your own Stytch credentials.

In the Stytch Dashboard

1. Create a Stytch account. Once your account is set up a Project called "My first project" will be automatically created for you.

2. Within your new Project, navigate to SDK configuration, and click Enable SDK.

3. Navigate to OAuth, and enable login for Google in the Test environment. Config will be done for you automatically in Test.

   

4. Finally, navigate to API Keys. You will need the project_id, secret, and public_token values found on this page later on.

On your machine

In your terminal clone the project and install dependencies:

git clone https://github.com/cal-stytch/stytch-nextjs-pages-router-example.git
cd stytch-nextjs-pages-router-example
# Install dependencies, you may use either pnpm or npm.
pnpm i
# or
npm i

Next, create .env.local file by running the command below which copies the contents of .env.template.

cp .env.template .env.local

Open .env.local in the text editor of your choice, and set the environment variables using the project_id, secret, and public_token found on API Keys. Leave the STYTCH_PROJECT_ENV value as test.

# This is what a completed .env.local file will look like
STYTCH_PROJECT_ENV=test
STYTCH_PROJECT_ID=project-test-00000000-0000-1234-abcd-abcdef1234
NEXT_PUBLIC_STYTCH_PUBLIC_TOKEN=public-token-test-abcd123-0000-0000-abcd-1234567abc
STYTCH_SECRET=secret-test-12345678901234567890abcdabcd

Running locally

After completing all the set up steps above the application can be run with the command:

pnpm run dev
# or
npm run dev

The application will be available at http://localhost:3000.

You'll be able to login with Email Magic Links or Google OAuth and see your Stytch User object, Stytch Session, and see how logging out works.

Next steps

This example app showcases a small portion of what you can accomplish with Stytch. Here are a few ideas to explore:

1. Add additional login methods like Passwords.
2. Replace the prebuilt UI with your own using by using the SDK's headless methods.
3. Replace the Google OAuth button with the high converting Google One Tap UI.
4. Secure your app further by building MFA authentication using methods like WebAuthn.

Get help and join the community

💬 Stytch community Slack

Join the discussion, ask questions, and suggest new features in our ​Slack community!

❓ Need support?

Check out the Stytch Forum or email us at support@stytch.com.