An open API service indexing awesome lists of open source software.

https://github.com/aksarav/confmap

JSON to mindmap, Yaml to MindMap - Visualize your Configuration files as mindmap with search and export features
https://github.com/aksarav/confmap

client-side data-privacy json mindmap opensource visualization yaml

Last synced: 2 days ago
JSON representation

JSON to mindmap, Yaml to MindMap - Visualize your Configuration files as mindmap with search and export features

Awesome Lists containing this project

README

          

[![Build](https://img.shields.io/badge/build-passing-brightgreen)](#)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen)

# ConfMap

An open-source library for mind map visualization of YAML, JSON, and YML configuration files, featuring an intelligent 13-level color-coding system.

[![Watch the Demo](confmap-demo.png)](https://youtu.be/kYD43daiwp4)

## ๐Ÿš€ Try ConfMap Now
**Visit [https://confmap.com](https://confmap.com) to use the interactive visualizer**

Upload your YAML, JSON, or YML files and instantly see them transformed into beautiful, interactive mind maps with intelligent 13-level color coding.

## โœจ Features

- **๐ŸŽจ Intelligent Color Coding**: 13 distinct colors for different hierarchy levels
- **๐Ÿ“ Multi-format Support**: YAML, JSON, and YML files
- **๐Ÿ” Enhanced Search**: Find and highlight ALL matching nodes with F3/Shift+F3 navigation
- **๐ŸŽฏ Multiple Layouts**: Horizontal, Vertical, and Radial views
- **๐Ÿ“ฑ Responsive Design**: Works on all device sizes
- **๐ŸŽฏ Node Focus**: Right-click to focus on specific nodes
- **๐Ÿ“Š Visual Hierarchy**: Clear column-based organization
- **๐Ÿงน TidyUp Mode**: Alt+T to show only the lineage of a selected node (path from root + all descendants)
- **๐Ÿ“‹ Copy Lineage**: Ctrl+C to copy the lineage tree of a selected node to clipboard in multiple formats
- **๐Ÿ“‚ Toggle Expand/Collapse**: Alt+E or button click to toggle between expanding all nodes and collapsing all nodes
- **๐Ÿ“ Word Wrapping**: Alt+W to toggle word wrapping for lengthy node text, improving readability of long configuration keys

## ๐Ÿš€ Getting Started

**Option 1: Use the Hosted Version (Recommended)**
1. Visit [https://confmap.com](https://confmap.com)
2. Upload your configuration file
3. Start exploring immediately

**Option 2: Run Locally**
1. Clone this repository
2. Install dependencies with `npm install`
3. Run `npm run dev` for development
4. Open `map.html` in your browser

## ๐Ÿ› ๏ธ Technical Details

- Built with **TypeScript** and **ECharts**
- Responsive design with **Tailwind CSS**
- Supports deep nesting up to 13 levels
- Automatic color cycling for deeper levels
- Interactive tooltips with level information
- Legend showing all color levels
- Smart text wrapping for improved readability

## โŒจ๏ธ Keyboard Shortcuts

| Shortcut | Action |
|----------|--------|
| `Alt + T` | Toggle TidyUp Mode (show lineage of selected node) |
| `Alt + E` | Toggle Expand/Collapse all nodes |
| `Alt + W` | Toggle word wrapping for lengthy text |
| `Ctrl + C` | Copy lineage of selected node to clipboard |
| `โ†‘ / โ†“` | Navigate through search results |
| `Escape` | Exit TidyUp mode |

## ๐Ÿ”ง Development

```bash
# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build
```

## ๐Ÿค Contributing

We welcome contributions! Open issues, propose features, or submit PRs. Please keep the code style consistent and ensure the UI remains responsive and privacy-first. Note that this is the source code for the ConfMap tool - please respect the intended usage patterns.

## ๐Ÿ“ฑ Usage Examples

### Kubernetes Configurations
Perfect for visualizing complex Kubernetes YAML files with multiple nested levels. Use Alt+W to enable word wrapping for long resource names and configuration keys.

### Application Configs
Great for understanding application configuration hierarchies and relationships. Word wrapping helps with lengthy environment variable names and configuration paths.

### Infrastructure as Code
Ideal for Terraform, CloudFormation, and other IaC configurations. The word wrap feature is especially useful for long resource identifiers and policy statements.

## ๐ŸŽฏ Use Cases

- **Configuration Analysis**: Understand complex nested configurations
- **Documentation**: Create visual documentation of system architectures
- **Onboarding**: Help new team members understand system structures
- **Troubleshooting**: Visualize configuration relationships and dependencies
- **Planning**: Plan configuration changes with visual context

---

**Developed with โค๏ธ From India**