Skip to main content

​
Prerequisites

  • Node.js 18+ (latest LTS recommended)
  • npm (or another compatible package manager)
  • A Convex project and deployment
  • WorkOS app credentials (client ID + API key)
  • (Optional) Rust + Tauri v2 toolchain for desktop builds

​
Environment

Create a .env.local in the project root and add at minimum: bash 
# Convex
NEXT_PUBLIC_CONVEX_URL=...

# WorkOS AuthKit
WORKOS_CLIENT_ID=...
WORKOS_API_KEY=...
WORKOS_COOKIE_PASSWORD=...
NEXT_PUBLIC_WORKOS_REDIRECT_URI=...
Follow WorkOS/AuthKit Next.js docs if you need additional callback/session variables for your WorkOS configuration.

​
Install & Run (Web)

  1. Install dependencies
bash 
npm install
  1. Run development servers (Next.js + Convex)
bash 
npm run dev
This runs:
  • next dev (Next.js app)
  • npx convex dev (local Convex dev server)
  1. Open the app

​
Build & Deploy (Web)

  • Build (deploy Convex then build Next.js):
bash 
npm run build
  • Start production server:
bash 
npm run dev
Deploy as a standard Next.js app (Vercel or other provider). Ensure Convex is deployed and environment variables are configured in your hosting provider.\
Need help? Please feel free to message me at contact@freddiephilpot.dev