sepehr/Keep
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Keep/RELEASE-NOTES.md
sepehr 640fcb26f7 fix: improve note interactions and markdown LaTeX support 
## 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
2026-01-09 22:13:49 +01:00

7.7 KiB
Raw Blame History

Release Notes - Memento v1.0.0

🎉 First Public Release!

Memento v1.0.0 is a complete Google Keep-inspired note-taking application built with modern web technologies. This release marks the first public availability of Memento as an open-source project.

✨ What's New in v1.0.0

🎯 Core Features

  • ✅ Note Management: Create, edit, delete notes with ease
  • ✅ Checklists: Create todo lists with checkable items
  • ✅ Rich Editing: Markdown support with live preview
  • ✅ Color Coding: 10 beautiful pastel themes
  • ✅ Labels: Organize notes with custom tags
  • ✅ Pin/Archive: Keep important notes at top, archive old ones
  • ✅ Search: Real-time full-text search across all notes
  • ✅ Undo/Redo: Full history support with keyboard shortcuts (Ctrl+Z, Ctrl+Y)
  • ✅ Reminders: Set reminders for important notes
  • ✅ Images: Upload and display images in notes

🔐 Authentication & Security

  • ✅ NextAuth.js: Secure authentication with multiple providers
  • ✅ Email/Password Login: Traditional credentials support
  • ✅ OAuth Support: Ready for Google, GitHub, etc.
  • ✅ Password Reset: Email-based password recovery
  • ✅ User Roles: Admin panel for advanced management

🤖 AI Integration

  • ✅ Auto-Tagging: Intelligent label suggestions powered by AI
  • ✅ Semantic Search: Find notes by meaning, not just keywords
  • ✅ Multi-Provider: Support for OpenAI and Ollama (local models)
  • ✅ Vector Embeddings: Advanced search with cosine similarity

🔌 Integrations

  • ✅ MCP Server: Full Model Context Protocol support
    • 9 MCP tools for AI/automation integration
    • Compatible with Claude Desktop, N8N workflows, etc.
    • Direct database access for real-time sync
  • ✅ REST API: Complete REST API for external integrations
  • ✅ Webhooks Ready: Architecture supports future webhook features

🎨 User Experience

  • ✅ Responsive Design: Works on desktop, tablet, and mobile
  • ✅ Dark Mode: Beautiful dark theme with system preference detection
  • ✅ Custom Themes: Light, Dark, Midnight, Sepia color schemes
  • ✅ Masonry Layout: Google Keep-style responsive grid
  • ✅ Drag & Drop: Reorder notes with drag-and-drop
  • ✅ Smooth Animations: Polished UI with transitions
  • ✅ Toast Notifications: Feedback for user actions

🛠️ Technical Features

  • ✅ Next.js 16: Latest App Router with Server Components
  • ✅ TypeScript: Full type safety throughout
  • ✅ Tailwind CSS 4: Modern utility-first styling
  • ✅ Prisma ORM: Type-safe database operations
  • ✅ SQLite Database: Zero-config database (PostgreSQL ready)
  • ✅ Server Actions: Lightning-fast mutations
  • ✅ PWA Support: Progressive Web App capabilities
  • ✅ Docker Ready: Complete Docker Compose setup

🔧 Installation

Quick Start (Docker)

# Clone the repository
git clone https://github.com/yourusername/memento.git
cd memento

# Start all services
docker compose up -d

# Access the application
open http://localhost:3000

Manual Installation

# Clone and navigate
git clone https://github.com/yourusername/memento.git
cd memento/keep-notes

# Install dependencies
npm install

# Setup database
npx prisma generate
npx prisma migrate dev

# Start development server
npm run dev

# Open in browser
open http://localhost:3000

For detailed installation instructions, see the Deployment Guide.

📚 Documentation

Complete documentation available in the docs/ directory:

🐛 Bug Fixes

This initial release includes:

  • ✅ Clean codebase (all debug code removed)
  • ✅ Production-ready (console statements cleaned)
  • ✅ Type-safe (full TypeScript coverage)
  • ✅ Tested (E2E tests with Playwright)

🔄 Migration from v0.x

If you're upgrading from earlier versions:

  1. Backup your data: cp keep-notes/prisma/dev.db dev.db.backup
  2. Pull latest code: git pull origin main
  3. Install dependencies: npm install
  4. Run migrations: npx prisma migrate deploy
  5. Restart server: npm run dev or docker compose up -d --build

🚀 Performance

  • ⚡ Fast Initial Load: Server-side rendering with Next.js
  • ⚡ Optimized Images: Next.js Image optimization
  • ⚡ Code Splitting: Automatic route-based splitting
  • ⚡ Database Queries: Indexed fields for fast queries
  • ⚡ Lazy Loading: Components loaded on demand

🔮 What's Next?

Planned for v1.1

  • Export notes to PDF/Markdown
  • Import from other note-taking apps
  • Keyboard shortcuts help dialog
  • More color themes
  • Note templates

Planned for v2.0

  • Real-time collaboration
  • Note sharing & permissions
  • Webhook integrations
  • Mobile apps (iOS/Android)
  • End-to-end encryption

🙏 Acknowledgments

Memento is built with amazing open-source tools:

  • Next.js - React framework
  • Prisma - Database ORM
  • Tailwind CSS - Styling
  • shadcn/ui - UI components
  • Radix UI - Accessible primitives
  • Lucide - Icons
  • Vercel AI SDK - AI integration
  • MCP SDK - Model Context Protocol

📄 License

MIT License - feel free to use Memento for personal or commercial projects!

☕ Support Development

Memento is 100% free and open-source! If you find it useful, please consider supporting its continued development:

One-Time Support

Recurring Support

  • 💚 Sponsor on GitHub - Monthly sponsorship
    • 🥉 Bronze ($5/mo): Name in supporters list
    • 🥈 Silver ($15/mo): Priority feature requests
    • 🥇 Gold ($50/mo): Logo in footer, priority support
    • 💎 Platinum ($100/mo): Custom features, consulting

Free Support

Your support helps:

  • ☕ Keep the developer fueled with coffee
  • 🐛 Cover hosting and server costs (~$50/month)
  • ✨ Fund development of new features
  • 📚 Improve documentation
  • 🌍 Keep Memento 100% open-source

📞 Get in Touch

Thank you for using Memento! Happy note-taking! 📝☕

Release Date: January 9, 2026 Version: 1.0.0 Status: Stable ✅