TaskFlow - Project Management Tool

TaskFlow is a comprehensive project management tool aimed at solving the pain points of development teams. It integrates various functionalities such as sprint management, roadmap planning, bug tracking, and team collaboration - all in one centralized platform.

Tech Stack

• Frontend: Next.js
• Authentication: Clerk
• Database: Supabase with Prisma ORM
• File Storage: Amazon S3 Buckets
• Payments: Stripe
• Deployment: Vercel

Prerequisites

• Node.js 18.x or later
• npm or yarn
• Supabase account
• Clerk account
• AWS account (for S3)
• Stripe account (for payments)

Setup Instructions

1. Clone the Repository

git clone git@github.com:rishiraj-58/taskflow.git
cd taskflow

2. Install Dependencies

npm install

3. Set Up Environment Variables

Create a .env file in the root directory with the following variables:

# Database - Supabase
DATABASE_URL="postgresql://postgres:password@localhost:5432/taskflow"

# Clerk Authentication
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key
CLERK_SECRET_KEY=your_clerk_secret_key
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/dashboard
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/onboarding
CLERK_WEBHOOK_SECRET=your_clerk_webhook_secret

# Supabase
NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key

# AWS S3
AWS_ACCESS_KEY_ID=your_aws_access_key_id
AWS_SECRET_ACCESS_KEY=your_aws_secret_access_key
AWS_REGION=your_aws_region
AWS_BUCKET_NAME=your_bucket_name

Replace the placeholder values with your actual credentials.

4. Set Up Prisma

Run the following commands to set up the database:

# Generate Prisma client
npm run prisma:generate

# Run migrations (development)
npm run prisma:migrate:dev

# Deploy migrations (production)
npm run prisma:migrate:deploy

5. Set Up Clerk Webhooks

1. In your Clerk Dashboard, go to the Webhooks section
2. Create a new webhook pointing to https://your-domain.com/api/webhook/clerk
3. Copy the webhook secret and add it to your .env file as CLERK_WEBHOOK_SECRET
4. Select the following events to listen for:
   • user.created
   • user.updated
   • user.deleted

6. Run the Development Server

npm run dev

The application will be available at http://localhost:3000.

Deployment

The application is configured for deployment on Vercel. Connect your GitHub repository to Vercel and set up the required environment variables.

Development Workflow

1. Create a new branch for each feature or bug fix
2. Make your changes
3. Submit a pull request to the main branch
4. CI/CD will automatically run tests and linting checks

Available Scripts

• npm run dev - Start the development server
• npm run build - Build the production application
• npm run start - Start the production server
• npm run lint - Run linting checks
• npm run prisma:generate - Generate Prisma client
• npm run prisma:migrate:dev - Run database migrations in development
• npm run prisma:studio - Open Prisma Studio to view/edit database
• npm run prisma:migrate:deploy - Deploy migrations to production

License

MIT