## Bug Fixes ### Note Card Actions - Fix broken size change functionality (missing state declaration) - Implement React 19 useOptimistic for instant UI feedback - Add startTransition for non-blocking updates - Ensure smooth animations without page refresh - All note actions now work: pin, archive, color, size, checklist ### Markdown LaTeX Rendering - Add remark-math and rehype-katex plugins - Support inline equations with dollar sign syntax - Support block equations with double dollar sign syntax - Import KaTeX CSS for proper styling - Equations now render correctly instead of showing raw LaTeX ## Technical Details - Replace undefined currentNote references with optimistic state - Add optimistic updates before server actions for instant feedback - Use router.refresh() in transitions for smart cache invalidation - Install remark-math, rehype-katex, and katex packages ## Testing - Build passes successfully with no TypeScript errors - Dev server hot-reloads changes correctly
7.0 KiB
7.0 KiB
Memento - Project Documentation Index
Project Overview
- Type: Multi-part with 2 parts
- Primary Language: TypeScript (keep-notes), JavaScript (mcp-server)
- Architecture: Full-stack JAMstack with Microservice Extension
Quick Reference
keep-notes (Memento Web App)
- Type: Web Application
- Tech Stack: Next.js 16 + React 19 + TypeScript 5 + Prisma + SQLite
- Entry Point: keep-notes/app/layout.tsx
- Architecture Pattern: Full-stack JAMstack with App Router
mcp-server (MCP Server)
- Type: Backend API
- Tech Stack: Express 4 + MCP SDK 1.0.4 + Prisma + SQLite (shared)
- Entry Point: mcp-server/index.js
- Architecture Pattern: Microservice API
Generated Documentation
Core Documentation
- Project Overview
- Source Tree Analysis (To be generated)
- Component Inventory (To be generated)
API Documentation
Data & Architecture
- Data Models
- Architecture - keep-notes (To be generated)
- Architecture - mcp-server (To be generated)
- Integration Architecture (To be generated)
Development Guides
- Development Guide - keep-notes (To be generated)
- Deployment Guide (To be generated)
Existing Documentation
Root Documentation
- README.md - Main project README
- CHANGELOG.md - Version history and changes
- COMPLETED-FEATURES.md - Completed features list
Technical Documentation
- MCP-GUIDE.md - MCP integration guide
- MCP-LIGHTWEIGHT-TEST.md - MCP testing notes
- MCP-SSE-ANALYSIS.md - Server-Sent Events implementation
- N8N-MCP-SETUP.md - N8N workflow integration
- N8N-TECH-NEWS.md - N8N technical news workflow
Component Documentation
- keep-notes/README.md - Web app README
- mcp-server/README.md - MCP server README
- mcp-server/N8N-CONFIG.md - N8N configuration
- mcp-server/README-SSE.md - SSE variant documentation
Planning Artifacts
Product Planning
- PRD - Product Requirements Document
- PRD - Web App Requirements
- PRD - Executive Summary
- PRD - Auth/Admin
Development Planning
- Epics - Epic definitions
- Implementation Readiness Report
Implementation Artifacts
- Stories - User stories and implementation details
- Infrastructure setup stories
- AI abstraction stories
- Search and tagging features
- Vector indexing and semantic search
- Model configuration interface
Getting Started
Prerequisites
- Node.js 20+
- npm or yarn
- SQLite3 (included)
Installation
Web Application:
cd keep-notes
npm install
npm run db:generate
npm run dev
# Access at http://localhost:3000
MCP Server:
cd mcp-server
npm install
npm start
Development Commands
Web App:
npm run dev- Start development servernpm run build- Build for productionnpm start- Start production servernpm test- Run E2E testsnpm run test:ui- Run tests with UInpm run db:generate- Regenerate Prisma client
MCP Server:
npm start- Start MCP server (stdio)npm run start:sse- Start SSE variant
Architecture Summary
Multi-Part Project Structure
Parts:
- keep-notes/ - Next.js web application (main user interface)
- mcp-server/ - Express-based MCP server (N8N integration)
Integration:
- Shared SQLite database (
keep-notes/prisma/dev.db) - Database-mediated communication
- Independent deployment capability
Technology Stack
Frontend:
- Next.js 16.1.1 (App Router)
- React 19.2.3
- TypeScript 5
- Tailwind CSS 4
- Radix UI
Backend:
- Next.js API Routes (keep-notes)
- Express 4.22.1 (mcp-server)
- Prisma 5.22.0 (ORM)
- SQLite (database)
Integration:
- MCP SDK 1.0.4
- NextAuth.js 5.0.0-beta.30
- Vercel AI SDK 6.0.23
Key Features
User Features
- Rich text notes with markdown support
- Checklist notes
- Color-coded notes
- Labeling/tagging system
- Pinning and archiving
- Image attachments
- Reminders with recurrence
- Drag-and-drop grid layout
- Semantic search (AI-powered)
- Auto-tagging (AI-powered)
- User authentication
- Admin panel
Technical Features
- Progressive Web App (PWA)
- Responsive design
- E2E testing (Playwright)
- MCP integration
- Multiple AI providers (OpenAI, Ollama)
- Email notifications
Current Status
Development Stage: Active Development
Branch: bmad-features
Version: 0.2.0
Completed:
- ✅ 6 user stories implemented
- ✅ PRD and Epics defined
- ✅ Sprint tracking active
- ✅ Core features functional
In Progress:
- 🔄 Docker setup
- 🔄 Documentation completion
- 🔄 Code review and cleanup
- 🔄 Monetization planning
Documentation for AI Agents
When working with this codebase, AI agents should reference:
- Project Context: Read project-overview.md first
- API Contracts: Reference api-contracts-keep-notes.md and api-contracts-mcp-server.md
- Data Models: Understand schema from data-models.md
- PRD: Review prd.md for product context
- Epics: Check epics.md for planned features
Next Steps
Immediate:
- Complete Docker setup
- Finish documentation
- Code review
- Test cleanup
Short-term:
- Implement monitization ("Pay me a coffee")
- Business model analysis
- GitHub release preparation
Long-term:
- Feature enhancements
- Community building
- Integration marketplace
Contributing
Current Status: Pre-release, not accepting external contributions yet
Future: After GitHub release, contribution guidelines will be added
License
Status: To be determined (MIT/Apache/etc.) Business Model: Open source with optional paid features
Contact & Support
Issues: GitHub Issues (once published) Documentation: This index and linked files Technical Guides: Root-level markdown files
Last Updated: 2026-01-09 Documentation Generated by: BMAD Document Project Workflow