VaultNote

A secure, offline-first knowledge workspace inspired by Notion. All your data stays on your device - no cloud, no servers, no tracking.

Features

• 100% Offline - Works completely offline, no internet required
• Block-based Editor - Rich text editing with slash commands, drag-and-drop blocks
• Databases - Create databases with multiple views (Table, Board, Gallery, List, Calendar)
• Local Storage - All data stored in browser localStorage, encrypted and secure
• Zero Telemetry - No tracking, no analytics, no external requests
• Privacy First - Your data never leaves your device

Getting Started

Development

1. Install dependencies:

pnpm install

2. Start the development server:

pnpm dev

The app will be available at http://localhost:3000

Building for Production

Build the static files:

pnpm build

The built files will be in the dist directory. You can:

1. Open directly in browser (file:// protocol):

   • Navigate to dist/index.html in your file browser
   • Double-click to open in your default browser
   • Note: Some browsers may have restrictions with file:// protocol

2. Serve with a simple HTTP server (recommended):

   # Using Python
   cd dist
   python -m http.server 8000
   
   # Using Node.js (npx)
   cd dist
   npx serve
   
   # Using PHP
   cd dist
   php -S localhost:8000

   Then open http://localhost:8000 in your browser

3. Deploy to static hosting:

   • Upload the dist folder contents to any static hosting service
   • Examples: Netlify, Vercel, GitHub Pages, Cloudflare Pages
   • No server-side code required!

Offline Usage

VaultNote is designed to work completely offline:

• ✅ All data stored in browser localStorage
• ✅ No external API calls
• ✅ No network dependencies
• ✅ Works without internet connection
• ✅ Can be opened as a local file (file:// protocol)

Optional Features (Require Internet)

Some features are optional and require an internet connection:

• Maps - Google Maps integration (requires API key and internet)
• Link Previews - External link metadata fetching (gracefully degrades offline)

These features will show appropriate messages when offline or unavailable.

Data Storage

All your data is stored locally in your browser's localStorage:

• Location: Browser localStorage (key: vaultnote_data)
• Format: Encrypted JSON
• Backup: Use the Export feature to backup your data
• Restore: Use the Import feature to restore from backup

Security

VaultNote implements comprehensive security measures to protect your data:

Data Protection

• AES-256-GCM Encryption - Military-grade encryption for all data at rest
• Password Protection - Optional vault password with auto-lock
• Secure Key Derivation - PBKDF2 with 600,000 iterations
• Memory Protection - Secure wiping of sensitive data

Network Security

• Network Isolation - All external requests blocked
• Content Security Policy - Strict CSP headers prevent XSS
• No Telemetry - Zero tracking or analytics
• Offline-First - No data ever leaves your device

Input Security

• XSS Protection - Comprehensive HTML sanitization
• Input Validation - All user input validated and sanitized
• Prototype Pollution Prevention - JSON parsing protection
• URL Validation - Dangerous protocols blocked

Access Control

• Session Timeout - Auto-lock after inactivity (configurable)
• Rate Limiting - Brute force protection (5 attempts, 15-min lockout)
• Activity Monitoring - Tracks user activity for auto-lock
• Secure Deletion - Data securely wiped on deletion

Audit & Monitoring

• Security Event Logging - Tracks all security events
• Failed Attempt Tracking - Monitors unlock attempts
• Network Block Logging - Records blocked requests

See SECURITY.md for detailed security documentation.

Keyboard Shortcuts

• Ctrl/Cmd + P - Quick search / Command palette
• Ctrl/Cmd + K - Quick actions
• Ctrl/Cmd + N - New page
• Ctrl/Cmd + \ - Toggle sidebar
• Ctrl/Cmd + / - Show keyboard shortcuts
• / - Slash commands in editor

Technology Stack

• React 19 - UI framework
• TypeScript - Type safety
• Vite - Build tool
• Tailwind CSS - Styling
• Radix UI - Accessible components
• localStorage - Data persistence

License

MIT

Contributing

Contributions are welcome! Please ensure all changes maintain the offline-first principle - no external network requests unless explicitly optional and clearly marked.