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

https://github.com/shashwat-19/filenest

FileNest is a fast, lightweight Java tool with a Mac-ready .dmg installer that organizes files by extension, keeping your directories clean and clutter-free.
https://github.com/shashwat-19/filenest

automation cross-platform customize direcotry efficiency error-handling exception-handling file-handling-in-java file-manager file-organization java java-filemanager

Last synced: 16 days ago
JSON representation

FileNest is a fast, lightweight Java tool with a Mac-ready .dmg installer that organizes files by extension, keeping your directories clean and clutter-free.

Awesome Lists containing this project

README

          


FileNest Banner

[![GitHub stars](https://img.shields.io/github/stars/Shashwat-19/FileNest?style=social)](https://github.com/Shashwat-19/FileNest/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/Shashwat-19/FileNest?style=social)](https://github.com/Shashwat-19/FileNest/network)
[![GitHub issues](https://img.shields.io/github/issues/Shashwat-19/FileNest)](https://github.com/Shashwat-19/FileNest/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/Shashwat-19/FileNest)](https://github.com/Shashwat-19/FileNest/pulls)
[![License](https://img.shields.io/github/license/Shashwat-19/FileNest)](./LICENSE)
[![GitHub release](https://img.shields.io/github/v/release/Shashwat-19/FileNest)](https://github.com/Shashwat-19/FileNest/releases)
[![Platform](https://img.shields.io/badge/platform-Windows%20|%20macOS%20|%20Linux-blue)](#)
[![Build](https://img.shields.io/badge/build-passing-brightgreen)](#)
[![Open Source](https://img.shields.io/badge/Open%20Source-Yes-green)](#)
[![Contributions Welcome](https://img.shields.io/badge/Contributions-Welcome-brightgreen)](#)

```
███████╗██╗██╗ ███████╗███╗ ██╗███████╗███████╗████████╗
██╔════╝██║██║ ██╔════╝████╗ ██║██╔════╝██╔════╝╚══██╔══╝
█████╗ ██║██║ █████╗ ██╔██╗ ██║█████╗ ███████╗ ██║
██╔══╝ ██║██║ ██╔══╝ ██║╚██╗██║██╔══╝ ╚════██║ ██║
██║ ██║███████╗███████╗██║ ╚████║███████╗███████║ ██║
╚═╝ ╚═╝╚══════╝╚══════╝╚═╝ ╚═══╝╚══════╝╚══════╝ ╚═╝
```

## Overview
FileNest is a **community-driven, open-source** file management application designed to streamline file organization through intelligent categorization and user-friendly interfaces. Built with Java and maintained by contributors worldwide, this project addresses the critical challenge of managing digital file systems efficiently across Windows, macOS, and Linux platforms.

### 🌟 **Why Open Source?**
- **Transparency**: Complete source code visibility for security and trust
- **Community-Driven**: Features and improvements driven by user needs
- **Educational**: Learn from real-world Java application development
- **Collaborative**: Join a growing community of developers and users
- **Free Forever**: No licensing fees or hidden costs

---

## 📦 Latest Release: [v3.2](https://github.com/Shashwat-19/FileNest/releases/tag/v3.2)
FileNest v3.2 is now live! 🎉
This version introduces **Stats-Functionality**, making file organization even more intuitive and efficient.

### 🚀 **Community Contributions in v3.2**
- Enhanced UI/UX based on community feedback
- Performance optimizations suggested by contributors
- Bug fixes reported by users
- New features requested through GitHub issues

---

## ✨ **Features**
- **Multi-Platform Support** — Works seamlessly on **Windows, macOS, and Linux**.
- **Graphical User Interface (GUI)** — Simple and intuitive interface for easy navigation.
- **Smart File Categorization** — Automatically sorts files into folders based on type (Images, Documents, Videos, etc.).
- **Drag-and-Drop Functionality** — Effortlessly move files into the application for quick sorting.
- **Optimized Performance** — Handles large directories efficiently without lag.
- **Trash Management** — Moves unnecessary files to the trash safely on all supported operating systems.
- **Stats Feature** — View detailed statistics on your file system, including total file count, file types, largest files, and more for better file management.
- **Open Source** — Full source code available for review, modification, and contribution.
- **Community Driven** — Features and improvements based on user feedback and contributions.

---

## 📚 Tech Stack
- **Language**: Java ☕️
- **File Handling**: Java IO & NIO
- **GUI Framework**: Swing (Now with Drag & Drop support!)
- **Event Handling**: Java Event Listeners

---

## System Components
```
FileNest/
├── .github/
├── .vscode/
├── src/
│ └── com/
│ └── filenest/
│ └── FileOrganizer.java
├── libs/
├── assets/
│ ├── images/
│ └── icons/
│ ├── MyIcon.iconset/
│ └── MyIcon.icns
├── input/
│ ├── input-folder/
│ └── temp-input/
├── output/
│ ├── out/
│ └── other generated files
├── dist/
│ ├── FileNest.jar
│ ├── FileOrganizer.class
│ └── manifest.txt
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── SECURITY.md
└── CODE_OF_CONDUCT.md
```
---

## 🔗 Dependencies

Make sure these are installed before running **FileNest**:

- **Java (JDK 8 or higher)** ☕️
- macOS: `brew install openjdk@17`
- Linux: `sudo apt install openjdk-17-jdk`
- Windows: [Download JDK](https://www.oracle.com/java/technologies/javase-downloads.html)

- **Git** 🌀
- macOS: `brew install git`
- Linux: `sudo apt install git`
- Windows: [Download Git](https://git-scm.com/download/win)

- **Maven (Optional)** ⚙️
- macOS: `brew install maven`
- Linux: `sudo apt install maven`
- Windows: [Download Maven](https://maven.apache.org/download.cgi)
---
## 🛠️ Installation Guide

### **Windows Users**
1. **Clone the Repository:**
```sh
git clone https://github.com/Shashwat-19/FileNest.git
cd FileNest
```
2. **Compile the Java Program:**
```sh
javac FileOrganizer.java
```
3. **Run the Program:**
```sh
java FileOrganizer
```

## 💻 MacOS Users
🔽 **Download FileNest v3.2 for macOS**: [Download Here](https://drive.google.com/file/d/1_SnN4VN4LGvKE_X2e0r-tIJZ-UyQ3Dcm/view?usp=drive_link)

After downloading, simply install the `.dmg` file and launch the application.

### **Linux Users**
1. **Clone the Repository:**
```sh
git clone https://github.com/Shashwat-19/FileNest.git
cd FileNest
```
2. **Compile and Run:**
```sh
javac FileOrganizer.java
java FileOrganizer
```

---

## 📊 Performance Optimization
- **Caching strategies implemented**
- **Database indexing**
- **Load balancing and scaling strategies**

---

## 🤝 **Contributing to FileNest**

We welcome contributions from the community! Whether you're fixing bugs, adding features, improving documentation, or helping others, your contributions make FileNest better for everyone.

### **How to Contribute**

1. **Fork the Repository**
```bash
git clone https://github.com/your-username/FileNest.git
cd FileNest
```

2. **Create a Feature Branch**
```bash
git checkout -b feature/your-feature-name
```

3. **Make Your Changes**
- Follow our coding standards
- Add tests for new functionality
- Update documentation as needed

4. **Commit Your Changes**
```bash
git commit -m "Add: Brief description of your changes"
```

5. **Push and Create Pull Request**
```bash
git push origin feature/your-feature-name
```

### **Types of Contributions We Welcome**

- 🐛 **Bug Fixes** — Help us identify and fix issues
- ✨ **New Features** — Add functionality that benefits the community
- 📚 **Documentation** — Improve guides, README, and code comments
- 🎨 **UI/UX Improvements** — Enhance the user interface and experience
- ⚡ **Performance** — Optimize code for better performance
- 🧪 **Testing** — Add or improve test coverage
- 🌍 **Localization** — Help translate FileNest to other languages

### **Development Setup**

1. **Prerequisites**
- Java 8 or higher
- Git
- Your favorite IDE (IntelliJ IDEA, Eclipse, VS Code)

2. **Build from Source**
```bash
javac FileOrganizer.java
java FileOrganizer
```

3. **Run Tests**
```bash
# Add test commands here as they are implemented
```

### **Community Guidelines**

- **Be Respectful** — Treat all community members with respect
- **Be Constructive** — Provide helpful feedback and suggestions
- **Be Patient** — Remember that maintainers are volunteers
- **Follow Code of Conduct** — See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)

### **Reporting Issues**

Found a bug or have a feature request? We'd love to hear about it!

1. **Check Existing Issues** — Search [GitHub Issues](https://github.com/Shashwat-19/FileNest/issues) first
2. **Create New Issue** — Use our issue templates for bugs and feature requests
3. **Provide Details** — Include steps to reproduce, expected behavior, and system info

### **Getting Help**

- 💬 **Discussions** — Use [GitHub Discussions](https://github.com/Shashwat-19/FileNest/discussions) for questions
- 📧 **Email** — Contact maintainers at shashwat1956@gmail.com
- 📖 **Documentation** — Check our [Google Docs](https://docs.google.com/document/d/e/2PACX-1vRbfTTckjWkqay1_ddfWNF7Y0DK0qg-iy_ANYLU1S2_QObyYVq_y4rMJH4XnCYDnDHNZmZ4XfnKqIjr/pub)

---

## 🗺️ **Roadmap & Future Plans**

### **Upcoming Features** (Community Requested)
- [ ] **Plugin System** — Allow custom file categorization plugins
- [ ] **Cloud Integration** — Support for Google Drive, Dropbox, OneDrive
- [ ] **Advanced Filters** — More sophisticated file filtering options
- [ ] **Batch Operations** — Process multiple directories simultaneously
- [ ] **File Preview** — Quick preview of files before organization
- [ ] **Custom Categories** — User-defined file categorization rules
- [ ] **API Support** — REST API for programmatic access
- [ ] **Mobile App** — Companion mobile application

### **How to Suggest Features**
1. Open a [Feature Request](https://github.com/Shashwat-19/FileNest/issues/new?template=feature_request.md)
2. Describe the feature and its benefits
3. Community voting helps prioritize development

---

## 📖 Documentation
Since FileNest does not have an API, the documentation includes installation guides, usage instructions, and troubleshooting tips. The documentation is also available in [Google Docs](https://docs.google.com/document/d/e/2PACX-1vRbfTTckjWkqay1_ddfWNF7Y0DK0qg-iy_ANYLU1S2_QObyYVq_y4rMJH4XnCYDnDHNZmZ4XfnKqIjr/pub) for easy sharing and reference.

---

## 🌟 **Community & Recognition**

### **Contributors**
Thank you to all the amazing contributors who have helped make FileNest better!

[![Contributors](https://contrib.rocks/image?repo=Shashwat-19/FileNest)](https://github.com/Shashwat-19/FileNest/graphs/contributors)

### **Community Stats**
- ⭐ **Stars**: Growing community of supporters
- 🍴 **Forks**: Active development across the community
- 🐛 **Issues**: Community-driven bug tracking and feature requests
- 💬 **Discussions**: Active community conversations
- 📈 **Downloads**: Thousands of users worldwide

### **Recognition & Awards**
- 🏆 **Featured Project** — Highlighted in multiple developer communities
- 📰 **Blog Coverage** — Featured in tech blogs and tutorials
- 👥 **Community Choice** — Voted as a top file management tool

---

## 📝 Developer Blog

Curious about the story behind FileNest or how it was built?
I regularly share **development insights**, **Java tips**, and **behind-the-scenes tutorials** on my [Hashnode blog](https://hashnode.com/@Shashwat56).

### 🔍 Blog Highlights *(Coming Soon)*

- *How I Built FileNest – Tackling Cross-Platform File Organization in Java*
- *Implementing Drag-and-Drop in Swing UI – Made Easy*
- *Building the Stats Feature – Visualizing File System Data*
- *Open Source Best Practices – Lessons from FileNest Development*
- *Community-Driven Development – How User Feedback Shapes Features*

📰 **Read the full series and more here:**
[![Visit My Blog](https://img.shields.io/badge/Visit%20My%20Blog-2962FF?style=for-the-badge&logo=hashnode&logoColor=white)](https://shashwat-filenest.hashnode.dev/)

Stay tuned for new posts and updates!

## 🔒 License
This project is licensed under the **Mozilla Public License Version 2.0**.
For detailed licensing information, please refer to the [LICENSE](./LICENSE) file included in this repository.

---

## 📩 Contact & Community
### Shashwat - Project Maintainer
**Python & Java Developer | Cloud & NoSQL Enthusiast | Open Source Advocate**

- **Python & Java Development** – Automation, Backend Systems, APIs, and OOP
- **Cloud & NoSQL** – Docker, AWS, MongoDB, Firebase Firestore
- **UI/UX Design** – Creating user-focused, scalable, and visually engaging applications
- **Open Source** – Passionate about community-driven development and collaboration

---

## 🚀 **Join Our Open Source Community**
FileNest is more than just a project—it's a community of developers, users, and contributors working together to create the best file management experience possible.

## 🎉 **Get Started Today!**

Ready to join our open source community? Here's how:

1. **⭐ Star the Repository** — Show your support
2. **🍴 Fork the Project** — Create your own copy
3. **🐛 Report Issues** — Help us improve
4. **💡 Suggest Features** — Share your ideas
5. **🔧 Contribute Code** — Make FileNest better
6. **📢 Spread the Word** — Share with others

**Together, we're building the future of file management!** 🚀

### **Why Join Our Community?**
- 🤝 **Collaborate** with developers worldwide
- 📚 **Learn** from real-world Java development
- 🎯 **Contribute** to meaningful open source projects
- 🌟 **Build** your portfolio with recognized contributions
- 💡 **Innovate** with cutting-edge file management features

### **Community Channels**
- 💬 **GitHub Discussions** — Ask questions, share ideas, get help
- 🐛 **GitHub Issues** — Report bugs, request features
- 📧 **Email** — Direct contact for maintainers
- 📖 **Documentation** — Comprehensive guides and tutorials

### 📌 **Connect with the Maintainer**
[](https://github.com/Shashwat-19) [](https://www.linkedin.com/in/shashwatk1956/) [](mailto:shashwat1956@gmail.com) [](https://hashnode.com/@Shashwat56)
[](https://www.hackerrank.com/profile/shashwat1956)

---

**Enjoy organizing your files with FileNest v3.2!** 🎉