Unfold ✨

A minimalist desktop utility to flatten a nested folder structure into a single directory.

(Pictured: Main screen in light mode and the results screen in dark mode)

---

🚀 Key Features

• 📂 Effortless Folder Flattening: Simply select a folder, and Unfold recursively finds every file to bring it to the top level.
• ⚠️ Smart Conflict Handling: Intelligently renames files with duplicate names (e.g., [conflict-1]-image.jpg) so you never lose a file.
• 📝 Detailed & Interactive Logging: Get a beautiful, interactive, and fully translated summary right within the app after every operation.
• 💾 Markdown Documentation: A detailed documentation.md file is automatically generated in the output folder.
• 🎨 Persistent UI Settings: The app remembers your chosen window size, position, and light/dark theme between sessions.
• 🌍 Fully Localized: Complete interface, including the "About" page, is available in English & German with an easy-to-use language switcher.
• 🖥️ Cross-Platform: Works on Windows, macOS, and Linux.

⚙️ Getting Started

There are two ways to use Unfold: by installing the ready-to-use application or by running it from the source code.

For Users (Installation)

1. Go to the Releases Page.
2. Download the latest version for your operating system (.exe for Windows, .dmg for macOS, or .AppImage for Linux).
3. Run the installer or the application file. That's it!

For Developers (From Source)

If you want to contribute or run the app from the source code, follow these steps.

1. Prerequisites: Make sure you have Node.js installed on your system.

2. Clone & Install:

   # Clone the repository
   git clone https://github.com/x3kim/unfold.git
   
   # Navigate into the project directory
   cd unfold
   
   # Install the necessary dependencies
   npm install

3. Run & Build:

   # Run the application in development mode
   npm start
   
   # Build the packaged application for distribution
   npm run build

   The final application will be located in the dist/ directory.

🛠️ Built With

• Electron - The framework for building cross-platform desktop apps with web technologies.
• Node.js - For all the file system magic in the backend.
• HTML5, CSS3, Vanilla JavaScript - No heavy frameworks, just pure web tech for a lightweight and fast UI.

📄 License

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

Copyright (c) 2025 x3kim