diff --git a/store/seed/DEMO_DATA_GUIDE.md b/store/seed/DEMO_DATA_GUIDE.md deleted file mode 100644 index afd0ea4d..00000000 --- a/store/seed/DEMO_DATA_GUIDE.md +++ /dev/null @@ -1,205 +0,0 @@ -# Demo Data Guide - -This document describes the demo data used to showcase Memos features in demo mode. - -## Overview - -The demo data includes **6 carefully selected memos** that showcase the key features of Memos without overwhelming new users. - -## Demo User - -- **Username**: `demo` -- **Password**: `secret` (default password) -- **Role**: ADMIN -- **Nickname**: Demo User - -## Demo Memos (6 total) - -### 1. Welcome Message (Pinned) ⭐ -**Tags**: `#welcome` `#getting-started` - -A welcoming introduction that highlights key features of Memos. - -**Features showcased**: -- H1/H2 headings -- Bold text -- Bullet lists -- Horizontal rules -- Multiple tags - ---- - -### 2. Task Management Demo -**Tags**: `#todo/work` - -Realistic weekly task list with three categories showing different work contexts. - -**Features showcased**: -- Task lists (checkboxes) -- Hierarchical tags (`#todo/work`) -- Mixed completed/incomplete tasks -- H2/H3 headings -- Multiple sections - ---- - -### 3. Code Snippet Reference -**Tags**: `#dev/git` - -Practical Git commands reference with code examples in multiple languages. - -**Features showcased**: -- Multiple code blocks -- Bash syntax highlighting -- JavaScript syntax highlighting -- Inline code -- Hierarchical tags (`#dev/git`) - ---- - -### 4. Meeting Notes with Table -**Tags**: `#meeting/standup` - -Professional meeting notes with structured data in a table format. - -**Features showcased**: -- Markdown tables -- Bold text -- Bullet lists -- Hierarchical tags (`#meeting/standup`) -- Organized sections - ---- - -### 5. Quick Idea -**Tags**: `#ideas/apps` `#ai` - -Short-form idea capture demonstrating quick note-taking. - -**Features showcased**: -- Brief memo format -- Emoji usage -- Multiple tags -- Bold text - ---- - -### 6. Sponsor Message (Pinned) ⭐ -**Tags**: `#sponsor` - -Sponsor message with image and external link. - -**Features showcased**: -- External links -- Markdown image -- Pinned memo -- Clean formatting - ---- - -## Additional Features - -### Memo Relations -- Memo #3 (Git commands) references Memo #1 (Welcome) - -### Reactions -Multiple memos have reactions to showcase the reaction system: -- Welcome: 🎉 👍 -- Tasks: ✅ -- Quick idea: 💡 -- Sponsor: 🚀 - -### System Settings -Configured with popular reactions: -- 👍 💛 🔥 👏 😂 👌 🚀 👀 🤔 🤡 ❓ +1 🎉 💡 ✅ - -## Coverage of Markdown Features - -| Feature | Demo Memos | -|---------|-----------| -| Headings (H1-H3) | 1, 2, 3, 4 | -| Bold text | All | -| Links | 6 | -| Images | 6 | -| Code blocks | 3 | -| Inline code | 3 | -| Task lists | 2 | -| Bullet lists | 1, 2, 4 | -| Tables | 4 | -| Horizontal rules | 1 | -| Hierarchical tags | All | -| Emoji | 5 | -| Pinned memos | 1, 6 | - -## Tag Hierarchy - -The demo showcases hierarchical tag organization: - -``` -#welcome -#getting-started -#todo - └─ #todo/work -#dev - └─ #dev/git -#meeting - └─ #meeting/standup -#ideas - └─ #ideas/apps -#ai -#sponsor -``` - -## Use Cases Demonstrated - -1. **Getting Started**: Welcome message with feature overview -2. **Work Management**: Tasks and meetings -3. **Developer Tools**: Code snippet references -4. **Quick Capture**: Brief idea notes -5. **Sponsor Content**: Product showcases with images - -## Design Principles - -1. **Quality over Quantity**: 6 focused memos instead of overwhelming users -2. **Realistic Content**: All memos use realistic, relatable scenarios -3. **Diverse Use Cases**: Covers professional, technical, and creative contexts -4. **Visual Appeal**: Clean formatting with emojis used naturally -5. **Feature Coverage**: Core features demonstrated without redundancy -6. **Hierarchical Organization**: Shows multi-level tag organization -7. **Clean and Scannable**: Easy to browse and understand at a glance - -## Testing Demo Mode - -To run with demo data: - -```bash -# Start in demo mode -go run ./cmd/memos --demo --port 8081 - -# Or use the binary -./memos --demo - -# Demo database location -./build/memos_demo.db -``` - -Login with: -- Username: `demo` -- Password: `secret` - -## Updating Demo Data - -1. Edit `store/seed/sqlite/01__dump.sql` -2. Delete `build/memos_demo.db` if it exists -3. Restart server in demo mode -4. New demo data will be loaded automatically - -## Notes - -- All memos are set to PUBLIC visibility -- **Two memos are pinned**: Welcome (#1) and Sponsor (#6) -- User has ADMIN role to showcase all features -- Reactions are distributed across memos -- One memo relation demonstrates linking -- Content is optimized for the compact markdown styles -- Demo size is intentionally small (6 memos) to avoid overwhelming new users diff --git a/store/seed/sqlite/01__dump.sql b/store/seed/sqlite/01__dump.sql index cd06591c..609d4f5a 100644 --- a/store/seed/sqlite/01__dump.sql +++ b/store/seed/sqlite/01__dump.sql @@ -31,6 +31,9 @@ INSERT INTO memo (id,uid,creator_id,content,visibility,payload) VALUES(8,'gitche -- 9. Sponsor Memo (Pinned) — largest id so it sorts above Welcome among pinned memos INSERT INTO memo (id,uid,creator_id,content,visibility,pinned,payload) VALUES(9,'sponsor0000001',1,replace('Memos is free and open source, sustained by the companies and individuals who choose to back it. 🙏 Their support keeps the project independent — no ads, no telemetry, no paywalled features. If you build with Memos, please consider supporting them in return.\n\n## ⭐ Featured Sponsors\n\nCodeRabbit\n\nCut code review time & bugs in half, instantly.\n\n[coderabbit.link/usememos →](https://coderabbit.link/usememos)\n\n---\n\nWarp\n\nThe agentic development environment.\n\n[go.warp.dev/memos →](https://go.warp.dev/memos)\n\n## 🤝 Supporting Sponsors\n\n- [SSD Nodes — Affordable VPS hosting for self-hosters](https://ssdnodes.com/?utm_source=memos&utm_medium=sponsor)\n- [InstaPods — Get your app online in seconds](https://instapods.com/?utm_source=memos&utm_medium=sponsor)\n\n---\n\nWant to see your company here? Reach out via [GitHub Sponsors](https://github.com/sponsors/usememos) — sponsorships fund ongoing development and keep Memos free for everyone.\n\n#sponsors','\n',char(10)),'PUBLIC',1,'{"tags":["sponsors"],"property":{"hasLink":true}}'); +-- 10. Scratchpad Promo (Pinned) — largest id so it sorts above other pinned memos +INSERT INTO memo (id,uid,creator_id,content,visibility,pinned,payload) VALUES(10,'scratchpad0001',1,replace('## 🧩 Try Memos Scratchpad\n\nA lightweight visual canvas for quick thoughts, links, images, files, and small cards before they become polished notes.\n\n[Open Scratchpad →](https://usememos.com/scratchpad)\n\n| Need | Scratchpad helps you |\n|------|----------------------|\n| Capture fast | Double-click to add notes |\n| Arrange freely | Drag cards around |\n| Add context | Attach files, links, and images |\n| Move around | Zoom and pan without setup |\n\n### Local-first\n\nYour Scratchpad cards stay in your browser. Memos does not access, sync, or store them.','\n',char(10)),'PUBLIC',1,'{"tags":["scratchpad"],"property":{"hasLink":true}}'); + -- Memo Relations INSERT INTO memo_relation VALUES(6,1,'COMMENT'); -- Alice comments on Welcome INSERT INTO memo_relation VALUES(7,3,'COMMENT'); -- Alice comments on Git Cheat Sheet @@ -47,6 +50,8 @@ INSERT INTO reaction (id,creator_id,content_id,reaction_type) VALUES(7,1,'memos/ INSERT INTO reaction (id,creator_id,content_id,reaction_type) VALUES(8,2,'memos/sponsor0000001','👍'); INSERT INTO reaction (id,creator_id,content_id,reaction_type) VALUES(9,2,'memos/gitcheatsheet01','🔥'); INSERT INTO reaction (id,creator_id,content_id,reaction_type) VALUES(10,2,'memos/travelbucket01','👀'); +INSERT INTO reaction (id,creator_id,content_id,reaction_type) VALUES(11,1,'memos/scratchpad0001','💡'); +INSERT INTO reaction (id,creator_id,content_id,reaction_type) VALUES(12,2,'memos/scratchpad0001','🚀'); -- System Settings INSERT INTO system_setting VALUES ('MEMO_RELATED', '{"contentLengthLimit":8192,"enableAutoCompact":true,"enableComment":true,"enableLocation":true,"defaultVisibility":"PUBLIC","reactions":["👍","💛","🔥","👏","😂","👌","🚀","👀","🤔","🤡","❓","+1","🎉","💡","✅"]}', '');