Onboarding Guide

Get up and running with your development environment.

Prerequisites

  • Node.js 18.17 or later
  • npm, yarn, or pnpm package manager
  • A Convex account (free tier available)

Installation

npm install

Environment Setup

Create a .env.local file with your Convex deployment URL:

NEXT_PUBLIC_CONVEX_URL=your-convex-url

Development Server

Start the development server with:

npm run dev

This will start both the Next.js development server and the Convex development environment.

Project Structure

  • app/ - Next.js App Router pages and layouts
  • components/ - Reusable React components
  • convex/ - Backend functions and schema
  • lib/ - Utility functions and helpers

Next Steps

  1. Explore the application by navigating through different sections
  2. Try creating an account and signing in
  3. Check out the protected application pages
  4. Review the Server API documentation