sepehr/Momento
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: rename keep-notes to memento-note, migrate to PostgreSQL, fix MCP bugs

Browse Source 
- Rename directory keep-notes -> memento-note with all code references
- Prisma: SQLite -> PostgreSQL (both app and MCP server schemas)
- Sync MCP schema with main app (add missing fields, relations, indexes)
- Delete 17 SQLite migrations (clean slate for PostgreSQL)
- Remove SQLite dependencies (@libsql/client, better-sqlite3, etc.)
- Fix MCP server: hardcoded Windows DB paths -> DATABASE_URL env var
- Fix MCP server: .dockerignore excluded index-sse.js (SSE mode broken)
- MCP Dockerfile: node:20 -> node:22
- Docker Compose: add postgres service, remove SQLite volume
- Generate favicon.ico, icon-192.png, icon-512.png, apple-icon.png
- Update layout.tsx icons and manifest.json for PNG icons
- Update all .env files for PostgreSQL
- Rewrite README.md with updated sections
- Remove mcp-server/node_modules and prisma/client-generated from git tracking

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Sepehr Ramezani
2026-04-20 20:58:04 +02:00
parent e2ddfa53d4
commit aa6a214f37
3548 changed files with 440 additions and 516800 deletions
Download Patch File Download Diff File Expand all files Collapse all files

544
README.md
View File

@@ -1,432 +1,208 @@
# Memento - Your Digital Notepad ☕
# Memento - Smart Note-Taking App
A beautiful and functional note-taking app inspired by Google Keep, built with Next.js 16, TypeScript, Tailwind CSS 4, and Prisma.
A modern, AI-powered note-taking application inspired by Google Keep. Built with Next.js 16, PostgreSQL, Prisma, and Tailwind CSS 4.
## 🌟 Support Memento
![License](https://img.shields.io/badge/license-MIT-blue)
![Docker](https://img.shields.io/badge/docker-ready-blue)
![Node](https://img.shields.io/badge/node-22-green)
**Memento is 100% free and open-source!** If you find it useful, please consider supporting its development:
## Features
- **[☕ Buy me a coffee on Ko-fi](https://ko-fi.com/yourusername)** - One-time or monthly support
- **[💚 Sponsor on GitHub](https://github.com/sponsors/yourusername)** - Recurring support
- **[⭐ Star on GitHub](https://github.com/yourusername/memento)** - Free way to show support
### Core
- Create, edit, delete notes with text or checklists
- Pin, archive, and organize notes into notebooks
- Labels with contextual colors
- Real-time search across all notes
- 10 soft pastel color themes + dark mode
- Responsive masonry grid layout (1-5 columns)
- Image upload with original size preservation
- Drag-and-drop note reordering
- Markdown 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
### AI-Powered
- Automatic title suggestions
- Semantic search across notes
- Paragraph refactoring
- Memory Echo: surfaces connections between your notes
- Multi-provider: OpenAI, Ollama, or auto-detect
---
### MCP Server (22 Tools)
Full Model Context Protocol server for AI agent integration:
- **Notes**: create, read, update, delete, search, duplicate
- **Notebooks**: create, list, update, delete
- **Labels**: create, list, update, delete, assign to notes
- **System**: health check, stats, bulk operations
- Modes: stdio (Claude Desktop) or SSE (N8N, HTTP)
## 🚀 Project Location
### Authentication & Security
- NextAuth.js with credentials provider
- Email/password authentication
- Password reset via SMTP
- Role-based access (USER/ADMIN)
The complete application is in the `keep-notes/` directory.
## Quick Start (Local)
## ✅ Completed Features
### Core Functionality
- ✅ Create, read, update, delete notes
- ✅ Text notes and checklist notes
- ✅ Pin/unpin notes
- ✅ Archive/unarchive notes
- ✅ Real-time search across all notes
- ✅ Color customization (10 soft pastel themes)
- ✅ Label management
- ✅ Responsive masonry grid layout
- ✅ Drag-and-drop note reordering
- ✅ **Image upload with original size preservation**
### UI/UX Features
- ✅ Expandable note input (Google Keep style)
- ✅ Modal note editor with full editing (`!max-w-[min(95vw,1600px)]`)
- ✅ **Images display at original dimensions** (no cropping, `h-auto` without `w-full`)
- ✅ Hover effects and smooth animations
- ✅ **Masonry layout with CSS columns** (responsive: 1-5 columns)
- ✅ **Soft pastel color themes** (bg-red-50, bg-blue-50, etc.)
- ✅ Dark mode with system preference
- ✅ Mobile responsive design
- ✅ Icon-based navigation with 9 toolbar icons
- ✅ Toast notifications (via shadcn)
### Integration Features
- ✅ **REST API** (4 endpoints: GET, POST, PUT, DELETE)
- `/api/notes` - List all notes
- `/api/notes` - Create new note
- `/api/notes/[id]` - Update note
- `/api/notes/[id]` - Delete note
- ✅ **MCP Server** (Model Context Protocol) with 9 tools:
- `getNotes` - Fetch all notes
- `createNote` - Create new note
- `updateNote` - Update existing note
- `deleteNote` - Delete note
- `searchNotes` - Search notes by query
- `getNoteById` - Get specific note
- `archiveNote` - Archive/unarchive note
- `pinNote` - Pin/unpin note
- `addLabel` - Add label to note
### Technical Features
- ✅ Next.js 16 with App Router & Turbopack
- ✅ Server Actions for mutations
- ✅ TypeScript throughout
- ✅ Tailwind CSS 4
- ✅ shadcn/ui components (11 components)
- ✅ Prisma ORM 5.22.0 with SQLite
- ✅ Type-safe database operations
- ✅ **Base64 image encoding** (FileReader.readAsDataURL)
- ✅ **@modelcontextprotocol/sdk** v1.0.4
## 🏃 Quick Start
**Prerequisites:** Node.js 22, PostgreSQL 16
```bash
cd keep-notes
cd memento-note
npm install
npx prisma generate
npx prisma migrate dev
# Configure database
cp .env.example .env
# Edit .env with your PostgreSQL connection string
# Setup database
npx prisma migrate dev --name init
# Start development server
npm run dev
```
Then open http://localhost:3000
Open http://localhost:3000
## 📱 Application Features
## Docker Deployment
### 1. Note Creation
- Click the input field to expand
- Add title and content
- **Upload images** (displayed at original size)
- Switch to checklist mode with one click
- Add labels and choose from 10 soft pastel colors
### Using Docker Compose (root)
### 2. Note Management
- **Edit**: Click any note to open the editor (max-width: 95vw or 1600px)
- **Pin**: Click pin icon to keep notes at top
- **Archive**: Move notes to archive
- **Delete**: Remove notes permanently
- **Color**: Choose from 10 beautiful pastel colors
- **Labels**: Add multiple labels
- **Images**: Upload images that preserve original dimensions
### 3. Checklist Notes
- Create todo lists
- Check/uncheck items
- Add/remove items dynamically
- Strike-through completed items
### 4. Search & Navigation
- Real-time search in header
- Search by title or content
- Navigate to Archive page
- Dark/light mode toggle
### 5. API Integration
Use the REST API to integrate with other services:
```bash
# Get all notes
curl http://localhost:3000/api/notes
# Configure environment
cp .env.docker.example .env.docker
# Edit .env.docker with your settings
# Create a note
curl -X POST http://localhost:3000/api/notes \
-H "Content-Type: application/json" \
-d '{"title":"API Note","content":"Created via API"}'
# Start all services (PostgreSQL + app + MCP server)
docker compose up -d
# Update a note
curl -X PUT http://localhost:3000/api/notes/1 \
-H "Content-Type: application/json" \
-d '{"title":"Updated","content":"Modified via API"}'
# Delete a note
curl -X DELETE http://localhost:3000/api/notes/1
# Check status
docker compose ps
```
### 6. MCP Server for AI Agents
Start the MCP server for integration with Claude, N8N, or other MCP clients:
Services:
- **memento-note** - Web app on port 3000
- **postgres** - PostgreSQL 16 on port 5432 (configurable via `POSTGRES_PORT`)
- **mcp-server** - MCP server on port 3001 (SSE mode)
- **ollama** - Optional local LLM (use profile `--profile ollama`)
### Standalone (memento-note only)
```bash
cd keep-notes
npm run mcp
cd memento-note
chmod +x deploy.sh
./deploy.sh build
./deploy.sh start
```
The MCP server exposes 9 tools for AI agents to interact with your notes:
- Create, read, update, and delete notes
- Search notes by content
- Manage pins, archives, and labels
- Perfect for N8N workflows, Claude Desktop, or custom integrations
### Useful Commands
Example N8N workflow available in: `n8n-memento-workflow.json`
## 🛠️ Tech Stack
- **Frontend**: Next.js 16, React, TypeScript, Tailwind CSS 4
- **UI Components**: shadcn/ui (11 components: Dialog, Tooltip, Badge, etc.)
- **Icons**: Lucide React (Bell, Image, UserPlus, Palette, Archive, etc.)
- **Backend**: Next.js Server Actions
- **Database**: Prisma ORM 5.22.0 + SQLite (upgradeable to PostgreSQL)
- **Styling**: Tailwind CSS 4 with soft pastel themes (bg-*-50)
- **Layout**: CSS columns for masonry grid (responsive 1-5 columns)
- **Images**: Base64 encoding, original size preservation
- **Integration**: REST API + MCP Server (@modelcontextprotocol/sdk v1.0.4)
## 📂 Project Structure
```
keep-notes/
├── app/
│ ├── actions/notes.ts # Server actions (CRUD + images)
│ ├── api/notes/ # REST API endpoints
│ ├── archive/page.tsx # Archive page
│ ├── layout.tsx # Root layout
│ └── page.tsx # Home page
├── components/
│ ├── ui/ # shadcn components
│ ├── header.tsx # Navigation
│ ├── note-card.tsx # Note display (masonry, images)
│ ├── note-editor.tsx # Note editing (!max-w-[95vw])
│ ├── note-input.tsx # Note creation (image upload)
│ └── note-grid.tsx # Masonry layout
├── lib/
│ ├── types.ts # TypeScript types (Note with images)
│ └── utils.ts # Utilities
├── prisma/
│ ├── schema.prisma # Database schema (images String?)
│ └── dev.db # SQLite database
├── mcp/
│ └── server.ts # MCP server (9 tools)
└── package.json # Scripts: dev, build, start, mcp
```
│ ├── note-editor.tsx # Edit modal
│ ├── note-grid.tsx # Grid layout
│ └── note-input.tsx # Note creation
├── lib/
│ ├── prisma.ts # DB client
│ ├── types.ts # TypeScript types
│ └── utils.ts # Utilities
└── prisma/
├── schema.prisma # Database schema
└── migrations/ # DB migrations
```bash
docker compose logs -f memento-note # View logs
docker compose exec memento-note sh # Shell access
./deploy.sh backup # PostgreSQL backup (pg_dump)
./deploy.sh update # Pull, rebuild, restart
```
## 🎨 Color Themes
## MCP Server
The app includes 10 color themes:
- Default (White)
- Red
- Orange
- Yellow
- Green
- Teal
- Blue
- Purple
- Pink
- Gray
The MCP server enables AI agents to interact with your notes programmatically.
All themes support dark mode!
### Configuration
## 🔧 Configuration
Set in `.env.docker`:
```
MCP_MODE=stdio # or "sse" for HTTP/N8N
MCP_PORT=3001 # SSE mode port
```
### Database
Currently uses SQLite. To switch to PostgreSQL:
### N8N Integration
1. Edit `prisma/schema.prisma`:
```prisma
datasource db {
provider = "postgresql"
Configure an MCP tool node in N8N pointing to:
```
http://mcp-server:3001/sse
```
### Claude Desktop
Add to your `claude_desktop_config.json`:
```json
{
"mcpServers": {
"memento": {
"command": "node",
"args": ["path/to/mcp-server/index.js"],
"env": {
"DATABASE_URL": "postgresql://memento:memento@localhost:5432/memento"
}
}
}
}
```
2. Update `prisma.config.ts` with PostgreSQL URL
3. Run: `npx prisma migrate dev`
## Tech Stack
| Component | Technology |
|-----------|-----------|
| Frontend | Next.js 16, React 19, TypeScript |
| Styling | Tailwind CSS 4, shadcn/ui |
| Database | PostgreSQL 16, Prisma 5 |
| Auth | NextAuth.js v5 |
| AI | OpenAI SDK, Ollama |
| MCP | @modelcontextprotocol/sdk |
| Deploy | Docker, Docker Compose |
## Project Structure
```
memento-note/ # Main Next.js application
├── app/ # App Router pages & API routes
├── components/ # React components
├── lib/ # Utilities, Prisma client, i18n
├── prisma/ # Database schema & migrations
├── public/ # Static assets, icons, uploads
└── scripts/ # Utility scripts
mcp-server/ # MCP protocol server
├── index.js # Stdio mode entry
├── index-sse.js # SSE mode entry
├── prisma/ # Shared database schema
└── Dockerfile
docker-compose.yml # Root orchestration
.env.docker.example # Environment template
```
## Configuration
### Environment Variables
Located in `.env`:
```
DATABASE_URL="file:./dev.db"
```
## 🚀 Deployment
| Variable | Description | Default |
|----------|-------------|---------|
| `DATABASE_URL` | PostgreSQL connection string | `postgresql://memento:memento@localhost:5432/memento` |
| `POSTGRES_PORT` | PostgreSQL host port | `5432` |
| `POSTGRES_PASSWORD` | PostgreSQL password | `memento` |
| `NEXTAUTH_SECRET` | Auth encryption key | (required) |
| `NEXTAUTH_URL` | Public URL | `http://localhost:3000` |
| `AI_PROVIDER` | AI provider (`openai`, `ollama`, `auto`) | `auto` |
| `OPENAI_API_KEY` | OpenAI API key | (optional) |
| `OLLAMA_BASE_URL` | Ollama endpoint | (optional) |
| `MCP_MODE` | MCP server mode (`stdio` or `sse`) | `stdio` |
### 🐳 Docker Deployment (Recommended for Proxmox)
## Contributing
Keep Notes includes complete Docker configuration for easy deployment on Proxmox or any Docker host.
Contributions welcome! Please:
#### Quick Start
- [Report bugs](https://github.com/yourusername/memento/issues)
- [Suggest features](https://github.com/yourusername/memento/discussions)
- Submit pull requests
```bash
cd keep-notes
## Support
# Create environment file
cat > .env << EOF
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=$(openssl rand -base64 32)
EOF
Memento is free and open-source. If you find it useful:
# Build and start
docker-compose build
docker-compose up -d
- [Ko-fi](https://ko-fi.com/yourusername) - One-time or monthly support
- [BuyMeACoffee](https://buymeacoffee.com/yourusername) - Buy me a coffee
- [GitHub Sponsors](https://github.com/sponsors/yourusername) - Recurring support
- Star the repo - Free and helps visibility!
# Access at http://localhost:3000
```
## License
#### Deployment Script
We provide an automation script for common tasks:
```bash
chmod +x deploy.sh
# Build image
./deploy.sh build
# Start containers
./deploy.sh start
# View logs
./deploy.sh logs
# Backup database
./deploy.sh backup
# Update application
./deploy.sh update
```
#### Features
- ✅ **Multi-stage Docker build** for optimized image size
- ✅ **Persistent volumes** for database and uploads
- ✅ **Health checks** for automatic restart
- ✅ **Resource limits** for stable performance
- ✅ **Ollama support** for local AI models (optional)
- ✅ **Nginx reverse proxy** configuration included
- ✅ **Automated backups** with cron scripts
#### Architecture
```
keep-notes/
├── Dockerfile # Multi-stage build
├── docker-compose.yml # Container orchestration
├── .dockerignore # Build optimization
├── deploy.sh # Deployment automation
└── DOCKER_DEPLOYMENT.md # Complete guide
```
#### Supported Platforms
- **Proxmox VE** (LXC containers or VMs)
- **Docker hosts** (Linux, Windows, macOS)
- **Cloud providers** (AWS, GCP, Azure)
- **Kubernetes** (via Docker Compose)
#### AI Features Setup
**Option 1: OpenAI (Cloud)**
```yaml
# In .env or docker-compose.yml
OPENAI_API_KEY=sk-your-key-here
```
**Option 2: Ollama (Local AI)**
```bash
# Uncomment ollama service in docker-compose.yml
./deploy.sh start
./deploy.sh ollama-pull granite4
```
#### Documentation
See [DOCKER_DEPLOYMENT.md](keep-notes/DOCKER_DEPLOYMENT.md) for:
- Complete Proxmox deployment guide
- SSL/HTTPS configuration with Let's Encrypt
- Database backup and restore procedures
- Performance tuning and resource recommendations
- Troubleshooting common issues
- Security best practices
### ☁️ Vercel (Alternative)
For serverless deployment:
```bash
cd keep-notes
npm run build
vercel deploy
```
### 📦 Traditional Deployment
For traditional VPS or bare metal:
```bash
cd keep-notes
npm install
npx prisma generate
npx prisma migrate deploy
npm run build
npm start
```
## 📝 Development Notes
### Server Actions
All CRUD operations use Next.js Server Actions:
- `createNote()` - Create new note
- `updateNote()` - Update existing note
- `deleteNote()` - Delete note
- `getNotes()` - Fetch all notes
- `searchNotes()` - Search notes
- `togglePin()` - Pin/unpin
- `toggleArchive()` - Archive/unarchive
### Type Safety
Full TypeScript coverage with interfaces:
- `Note` - Main note type
- `CheckItem` - Checklist item
- `NoteColor` - Color themes
### Responsive Design
- Mobile: Single column
- Tablet: 2 columns
- Desktop: 3-4 columns
- Auto-adjusts with window size
## 🎯 Future Enhancements
Possible additions:
- [x] User authentication (NextAuth.js) ✅ Already implemented!
- [ ] Real-time collaboration
- [x] Image uploads ✅ Already implemented!
- [ ] Rich text editor
- [ ] Note sharing
- [x] Reminders ✅ Already implemented!
- [ ] Export to PDF/Markdown
- [ ] Voice notes
- [ ] Drawing support
## 🤝 Contributing
We welcome contributions! Please feel free to:
- **Report bugs**: [Open an issue](https://github.com/yourusername/memento/issues)
- **Suggest features**: [Start a discussion](https://github.com/yourusername/memento/discussions)
- **Submit pull requests**: Fork and create a PR
- **Share feedback**: [Support page](/support)
## ☕ Support Development
Enjoying Memento? Consider supporting its development:
- **[Donate on Ko-fi](https://ko-fi.com/yourusername)** - Buy me a coffee ☕
- **[GitHub Sponsors](https://github.com/sponsors/yourusername)** - Monthly sponsorship 💚
- **[Star the repo](https://github.com/yourusername/memento)** - It's free! ⭐
## 📄 License
MIT License - feel free to use for personal or commercial projects!
---
**Built with ❤️ and ☕ using Next.js 16, TypeScript, and Tailwind CSS 4**
Server running at: http://localhost:3000
**⭐ If you like Memento, please consider giving it a star on GitHub!**
MIT License - feel free to use for personal or commercial projects.