This template provides a minimal setup to get Convex working with Next.js. It uses Auth.js for user authentication.

Clone the template and install dependencies:

npm create convex@latest -- -t get-convex/convex-nextauth-template

Then:

1. Run npx convex dev --once, and follow the steps to provision a Convex backend
2. Generate private and public key by running node generateKeys.mjs
   • Paste the private key to the .env.local file
   • Paste the public key to your Convex dashboard, which you can open by running npx convex dashboard
3. Generate a random secret (via openssl rand -base64 33 or npx auth secret) and save it as AUTH_SECRET to the .env.local file
4. Generate another random secret and save it as CONVEX_AUTH_ADAPTER_SECRET to
   • the .env.local file
   • to your Convex dashboard
5. Follow this guide to create a GitHub OAuth app and then add AUTH_GITHUB_ID and AUTH_GITHUB_SECRET to .env.local
6. Follow this guide to sign up for Resend and then add AUTH_RESEND_KEY to .env.local

Now your .env.local should match .env.example and there should be JWKS and CONVEX_AUTH_ADAPTER_SECRET variables on your Convex dashboard.

You can now run:

npm run dev

and open your app at http://localhost:3000

See Convex docs at https://docs.convex.dev/home