Skip to content

jyodsh/mind-dump

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

16 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Mind Dump

An open-source, lightweight mind mapping application built with Tauri 2.x, React 18, and TypeScript.

Features

  • Intuitive Mind Mapping: Create and organize your thoughts with an easy-to-use interface
  • Fast & Lightweight: Built with Tauri for native performance and small bundle size
  • Canvas-based Rendering: Smooth pan and zoom with hardware-accelerated rendering
  • Flexible Layouts: Support for radial and manual layout modes
  • File Management: Save and load mind maps in JSON format
  • Export Options: Export to Markdown for easy sharing
  • Keyboard Shortcuts: Efficient workflow with comprehensive keyboard shortcuts
  • Cross-Platform: Works on macOS, Windows, and Linux

Installation (For Users)

Download the latest version from GitHub Releases.

macOS

  1. Download Mind Dump.dmg
  2. Open the DMG file
  3. Drag the app to your Applications folder
  4. Launch from Applications

Windows

  1. Download Mind Dump Setup.exe
  2. Run the installer
  3. Launch from Start Menu

Linux

  1. Download mind-dump.AppImage
  2. Make it executable: chmod +x mind-dump.AppImage
  3. Run: ./mind-dump.AppImage

Usage

Creating Nodes

  • Double-click anywhere on the canvas to create a new node
  • Double-click a node to edit its text

Connecting Nodes

  1. Hover over a node to see connection handles (blue circles with + icons)
  2. Click and drag from a handle to another node
  3. Release to create the connection

Navigation

  • Click & drag the background to pan the canvas
  • Mouse wheel to zoom in/out
  • Fit All button in toolbar to center all nodes

Selecting & Deleting

  • Click a node to select it
  • Cmd/Ctrl + Click for multi-select
  • Delete/Backspace key to delete selected items
  • Click a connection then press Delete to remove it

File Operations

  • πŸ’Ύ Save: Save your mind map as .json file
  • πŸ“‚ Open: Load an existing mind map
  • πŸ“€ Export: Export to Markdown format
  • ✨ New: Create a new mind map

Keyboard Shortcuts

  • Delete/Backspace - Delete selected items
  • Escape - Clear selection or cancel action

For Developers

Prerequisites

Development Setup

# Clone the repository
git clone https://github.com/jyodsh/mind-dump.git
cd mind-dump

# Install dependencies
npm install

# Run in development mode
npm run tauri dev

Building

# Build for production
npm run tauri build

Project Structure

mind-dump/
β”œβ”€β”€ src/                    # React frontend
β”‚   β”œβ”€β”€ components/         # UI components
β”‚   β”œβ”€β”€ core/              # Core rendering and data logic
β”‚   β”œβ”€β”€ stores/            # Zustand state management
β”‚   β”œβ”€β”€ types/             # TypeScript type definitions
β”‚   └── hooks/             # Custom React hooks
β”œβ”€β”€ src-tauri/             # Rust backend
β”‚   └── src/
β”‚       β”œβ”€β”€ commands/      # Tauri commands
β”‚       └── models/        # Data models
└── docs/                  # Documentation

Tech Stack

  • Frontend: React 18, TypeScript, Zustand, Tailwind CSS
  • Backend: Tauri 2.x, Rust
  • Build Tool: Vite
  • Validation: Ajv for JSON schema validation

Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature-name
  3. Make your changes
  4. Write or update tests
  5. Ensure all tests pass: npm run test
  6. Commit your changes: git commit -m 'Add some feature'
  7. Push to your branch: git push origin feature/your-feature-name
  8. Open a Pull Request

See CONTRIBUTING.md for detailed guidelines.

Testing

# Run tests
npm run test

# Run tests with coverage
npm run test:coverage

Code Quality

  • Follow TypeScript and ESLint rules
  • Use Prettier for code formatting
  • Write meaningful commit messages
  • Update documentation for new features

License

This project is licensed under the MIT License - see the LICENSE file for details.

Roadmap

v0.1.0 (MVP)

  • Basic node creation and editing
  • Node connections
  • Pan and zoom
  • Save/Load functionality
  • Export to Markdown
  • Undo/Redo
  • Radial layout

Future Versions

  • Multiple layout modes
  • Themes
  • Image attachments
  • Rich text editing
  • Plugin system
  • Cloud sync

Documentation

Complete documentation is available in the docs/ directory:

Quick links:

Support

Acknowledgments

Built with:

About

A simple mind map desktop app.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors 2

  •  
  •