whatisgoingon 1.0.8 → 1.0.9

package/README.md

@@ -6,48 +6,86 @@ A beautiful web UI to browse and explore your **Cursor AI** chat history.
 
 ## Features
 
-- 📅 **Date-based navigation** - Browse chats by date
+- 📅 **Date-based navigation** - Browse chats by date with conversation counts
 - 💬 **Conversation viewer** - See full chat content with user/AI messages
+- 📆 **Date separators** - Messages grouped by date with auto-scroll to selected day
 - ✅ **Multi-select** - Select multiple conversations for export
-- 📋 **Summary generation** - Generate markdown summaries of selected chats
-- 🔍 **Search** - Find chats across all workspaces
+- 📋 **Summary generation** - Generate markdown summaries with date filtering (Today/Yesterday/All)
 - 🎨 **Beautiful UI** - Modern dark theme with smooth animations
 
-## Usage
-
-### Quick Start (after publishing to npm)
+## Quick Start
 
 ```bash
 npx whatisgoingon
 ```
 
-This will start the server and automatically open your browser.
+This will start the server and automatically open your browser to http://localhost:3456.
+
+## Local Development
 
-### Local Development
+### Installation
 
 ```bash
-# Clone and install
+# Clone the repository
 git clone <your-repo-url>
 cd whatshappening
+
+# Install dependencies
 pnpm install
 cd frontend && pnpm install && cd ..
 
-# Build everything
+# Build native dependencies (required for better-sqlite3)
+cd node_modules/.pnpm/better-sqlite3@*/node_modules/better-sqlite3
+npm run build-release
+cd -
+```
+
+### Testing Locally (with build - production mode)
+
+```bash
+# Build everything (server + frontend)
 pnpm build
 
 # Start the app
 pnpm start
+# or
+node bin/cli.js
 ```
 
-### Development Mode
+Then open http://localhost:3456 in your browser.
+
+### Testing Locally (without build - development mode)
 
-Run with hot-reload for development:
+For hot-reload during development:
+
+```bash
+# Terminal 1: Start the backend server with auto-reload
+pnpm dev:server
+
+# Terminal 2: Start the frontend dev server
+pnpm dev:frontend
+```
+
+Or run both simultaneously:
 
 ```bash
 pnpm dev
 ```
 
-This runs both the backend (with tsx watch) and frontend (Vite dev server) simultaneously.
+- Backend runs on: http://localhost:3456
+- Frontend dev server runs on: http://localhost:5173 (with API proxy to backend)
+
+### Build Commands
+
+| Command | Description |
+|---------|-------------|
+| `pnpm build` | Build both server and frontend |
+| `pnpm build:server` | Build only the TypeScript server |
+| `pnpm build:frontend` | Build only the React frontend |
+| `pnpm start` | Start the production server |
+| `pnpm dev` | Start both servers in dev mode |
+| `pnpm dev:server` | Start backend with hot-reload |
+| `pnpm dev:frontend` | Start frontend with hot-reload |
 
 ## How It Works
 
@@ -67,8 +105,27 @@ All data is processed locally - nothing is sent to any external server.
 
 ## Requirements
 
-- Node.js 18+
+- Node.js 18+ (20.19+ or 22.12+ recommended for Vite)
 - Cursor IDE installed (with some chat history)
+- Build tools for native modules:
+  - **macOS**: Xcode Command Line Tools (`xcode-select --install`)
+  - **Windows**: Visual Studio Build Tools
+  - **Linux**: `build-essential` package
+
+## Troubleshooting
+
+### "No chats found"
+
+This usually means Cursor is running and has locked the database files. The app should still work, but you may need to restart Cursor or wait a moment.
+
+### Native module build errors
+
+If you get errors about `better-sqlite3` bindings not found:
+
+```bash
+cd node_modules/.pnpm/better-sqlite3@*/node_modules/better-sqlite3
+npm run build-release
+```
 
 ## License