Skip to content

KartikLabhshetwar/overwhelm-breaker

Repository files navigation

Overwhelm Breaker

A smart productivity app that helps you break down large projects into manageable tasks, schedule your work, and stay focused. Built with Next.js, TypeScript, and AI.

Deployed on Vercel

Key Features

  • AI-Powered Task Breakdown: Automatically break down large goals into smaller, actionable steps using the Groq API.
  • Project & Task Management: Organize your work into projects and "chunks" (manageable tasks).
  • Intelligent Scheduling: Plan your focus sessions for the week ahead.
  • Focus Mode: A dedicated, distraction-free interface to concentrate on one task at a time.
  • Dashboard & Analytics: Visualize your progress, track completed tasks, and monitor productivity trends.
  • Quick Capture: A central place to quickly add new ideas, tasks, and projects.

Tech Stack

Getting Started

Follow these instructions to get the project running on your local machine for development and testing purposes.

Prerequisites

  • Node.js (v18 or newer)
  • pnpm (or your preferred package manager)
  • A Neon account for the PostgreSQL database.
  • A Google Cloud Console project to set up OAuth.
  • A Groq account for the AI API key.

Installation & Setup

  1. Clone the repository:

    git clone https://github.com/your-username/overwhelm-breaker.git
    cd overwhelm-breaker
  2. Install dependencies:

    pnpm install
  3. Set up environment variables: Create a .env.local file in the root of the project by copying the example file:

    cp .env.example .env.local

    Update the file with your credentials for the database, NextAuth, Google OAuth, and Groq. You can find detailed instructions in LOCAL_SETUP.md.

  4. Set up the database: Connect to your Neon database and run the SQL scripts located in the /scripts directory in the following order:

    1. 001-create-tables.sql
    2. 002-add-nextauth-tables.sql

    For detailed instructions, see DATABASE_SETUP.md.

  5. Run the development server:

    pnpm dev

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

Available Scripts

In the project directory, you can run:

  • pnpm dev: Runs the app in development mode.
  • pnpm build: Builds the app for production.
  • pnpm start: Starts a production server.
  • pnpm lint: Runs the linter to check for code quality issues.

Releases

No releases published

Packages

 
 
 

Contributors