Sebastian Goscinski

Getting Started with Clerk and Next.js: A Secure and Scalable Authentication Solution

Sebastian Goscinski's photo
Sebastian Goscinski
·

3 min read

In the realm of modern web application development, authentication is a critical component that ensures only authorized users can access certain functionalities. Clerk.dev is an authentication and user management system that simplifies the incorporation of secure sign-in and user management features into your applications. When combined with Next.js, Clerk provides developers with a scalable and secure authentication solution that can be easily integrated into your web app.

In this advanced tutorial, we'll walk through setting up Clerk with a Next.js application, demonstrating how to implement a robust authentication flow.

Prerequisites

Before diving into the integration process, ensure you have:

  • Basic knowledge of React and Next.js.

  • Node.js and npm/yarn installed on your machine.

  • A Clerk.dev account (you can sign up for free to get started).

Step 1: Setting Up Next.js

First, let's create a new Next.js application if you haven't already done so:

npx create-next-app my-nextjs-app
cd my-nextjs-app

Step 2: Installing Clerk

Once your Next.js app is ready, install the Clerk Next.js SDK:

npm install @clerk/nextjs

Step 3: Configuring Clerk in Your Application

After installing the Clerk SDK, you need to configure Clerk to work with your Next.js app. Start by setting up your Clerk Frontend API and creating a .env.local file in the root of your Next.js project with the following content:

NEXT_PUBLIC_CLERK_FRONTEND_API=your-clerk-frontend-api.clerk.app

Replace your-clerk-frontend-api.clerk.app with the actual Frontend API value from your Clerk dashboard.

Step 4: Setting Up the ClerkProvider

Wrap your application in the ClerkProvider to manage the authentication state globally. Modify your _app.js file to include the provider like so:

import { ClerkProvider } from '@clerk/nextjs';
import { useRouter } from 'next/router';

function MyApp({ Component, pageProps }) {
  const { pathname } = useRouter();
  const isSignInOrSignUpPage = pathname.startsWith('/sign-in') || pathname.startsWith('/sign-up');

  return (
    <ClerkProvider {...pageProps}>
      {isSignInOrSignUpPage ? (
        <Component {...pageProps} />
      ) : (
        <ProtectedRoute>
          <Component {...pageProps} />
        </ProtectedRoute>
      )}
    </ClerkProvider>
  );
}

function ProtectedRoute({ children }) {
  const { isLoaded, isSignedIn } = useClerk();
  if (!isLoaded) return 'Loading...';
  if (!isSignedIn) {
    useRouter().push('/sign-in');
    return 'Redirecting to sign-in...';
  }
  return children;
}

export default MyApp;

This snippet ensures that Clerk is initialized and wraps your pages with a protected route component.

Step 5: Adding Sign-In and Sign-Up Pages

Create sign-in and sign-up pages to handle user authentication. Clerk provides components to easily add these features:

// pages/sign-in.js
import { SignIn } from '@clerk/nextjs';

const SignInPage = () => <SignIn path="/sign-in" routing="path" />;
export default SignInPage;

// pages/sign-up.js
import { SignUp } from '@clerk/nextjs';

const SignUpPage = () => <SignUp path="/sign-up" routing="path" />;
export default SignUpPage;

Step 6: Using the useUser Hook

Clerk's useUser hook allows you to access the authenticated user's data. Here's an example of how to use it inside a component:

import { useUser } from '@clerk/nextjs';

const UserProfile = () => {
  const { user } = useUser();

  if (!user) {
    return <div>Loading...</div>;
  }

  return (
    <div>
      <h1>Welcome, {user.firstName}!</h1>
      <p>Email: {user.emailAddresses[0].emailAddress}</p>
    </div>
  );
};

export default UserProfile;

Step 7: Running and Testing Your Application

Now, run your Next.js application and navigate to the sign-in and sign-up pages to test the authentication flow:

npm run dev

Visit http://localhost:3000/sign-in and http://localhost:3000/sign-up to see Clerk's authentication components in action.

Conclusion

You've successfully integrated Clerk with your Next.js application, providing a scalable and secure authentication system. Clerk's simplicity and integration with Next.js allow you to focus more on building features rather than worrying about the complexities of managing user authentication.

By following this guide, you have laid the groundwork for adding more advanced user management and security features to your application with Clerk. Continue to explore Clerk's documentation and Next.js to enhance your app's capabilities and provide an even richer user experience.

Clerk.devNext.jsauthentication