Getting Started

🚀 Quick Start

Prerequisites

• Node.js 18+
• npm or yarn
• Convex account (free)
• Clerk account (free)

1. Clone the Repository

git clone https://github.com/your-username/taskflow.git
cd taskflow
npm install

2. Environment Setup

cp .env.example .env.local

Fill in your credentials in .env.local:

# Get these from https://dashboard.convex.dev
CONVEX_DEPLOYMENT=your-deployment-name
NEXT_PUBLIC_CONVEX_URL=https://your-deployment-name.convex.cloud

# Get these from https://dashboard.clerk.dev
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_...
CLERK_SECRET_KEY=sk_test_...

3. Set Up Convex Database

# Install Convex CLI globally (if not already installed)
npm install -g convex

# Login and initialize
npx convex login
npx convex dev

This will:

• Create a new Convex project
• Generate your database schema
• Start the development server
• Generate TypeScript types

4. Run the Application

npm run dev

Visit http://localhost:3000 to see your app! 🎉