Clerk and Next.js App Router with Cypress E2E tests Quickstart

Introduction

Clerk is a developer-first authentication and user management solution. It provides pre-built React components and hooks for sign-in, sign-up, user profile, and organization management. Clerk is designed to be easy to use and customize, and can be dropped into any React or Next.js application.

After following the quickstart you'll have learned how to:

• Install @clerk/nextjs
• Set your Clerk API keys
• Add Clerk's middleware
• Add <ClerkProvider /> and Clerk components
• Run E2E Cypress tests

Running the template

npm run cypress:open

To run the example locally, you need to:

1. Sign up for a Clerk account at https://clerk.com.
2. Go to the Clerk dashboard and create an application.
3. Set the required Clerk environment variables as shown in the example env.local.example file.
4. npm install the required dependencies.
5. npm run dev to launch the development server.

Testing

1. See the testing-tokens.cy.ts file for Cypress E2E tests.
2. Set the test_user and test_password to the credentials of the test account shown in the example .cypress.env.json.example file.
3. npm run cypress:open to launch the development server. This will open the Cypress window, which must remain open throughout testing.
4. In Cypress, choose your preferred browser to test. A new browser window should open.
5. From Specs, select a test to run it.

If you aren't running your app on localhost:3000, update the baseUrl in cypress.config.ts to match your development server's URL.

Learn more

To learn more about Clerk and Next.js, check out the following resources:

• Quickstart: Get started with Next.js and Clerk
• Clerk Documentation
• Next.js Documentation
• Testing with Cypress
• Cypress Documentation

Found an issue or want to leave feedback

Feel free to create a support thread on our Discord. Our support team will be happy to assist you in the #support channel.

Connect with us

You can discuss ideas, ask questions, and meet others from the community in our Discord.

If you prefer, you can also find support through our Twitter, or you can email us!