Table of contents
- 🌟 Project Overview
- ✨ Features
- 🚀 Getting Started
- 🖥️ Usage
- 🛠️ Development
- 🤝 Contributing
- 📜 License
- 👏 Acknowledgments
- ❓ FAQ
- 🔮 Roadmap
- 📊 Project Stats
- 🌐 Localization
- 🔒 Security
- 💼 Support
- 🔗 Related Projects
- 📣 Spread the Word
- 👤 Author
- 🏆 Contributors
- 📝 Changelog
File Explorer is a modern, lightweight file management application built with C89 and featuring a vanilla JavaScript frontend with a custom template engine. It aims to provide a seamless and efficient file browsing experience while maintaining a small footprint and high performance.
- 🚀 Lightning-fast performance with C89 backend
- 🖥️ Intuitive UI powered by vanilla JavaScript
- 🛠️ Custom template engine for efficient rendering
- 📁 Multi-platform support (Linux, macOS)
- 🔍 Advanced search capabilities
- 🎨 Customizable themes
Before you begin, ensure you have met the following requirements:
- C compiler (gcc or clang)
- Node.js (for frontend development)
- libgtk-3-dev
- libwebkit2gtk-4.0-dev (Linux) or WebKit framework (macOS)
- pkg-config
- make
- Clone the repository:
git clone https://github.com/AlphaTechnolog/file-explorer.git
cd file-explorer- Initialize submodules:
git submodule update --init --recursive
- Install dependencies:
For Ubuntu/Debian:
sudo apt install libgtk-3-dev libwebkit2gtk-4.0-dev
For macOS:
brew install gtk+3
Note: For Arch Linux users, install
webkit2gtkinstead ofwebkitgtk-6.0.
- Build the project:
make
After successful compilation, you'll find the file-explorer binary in the project root.
After successful compilation, you'll find the file-explorer binary in the project root. To launch File Explorer, run the following command from the project directory:
./file-explorerThis command will open the File Explorer application in your terminal.
To run the test suite:
make test
We welcome contributions to File Explorer! Here's how you can help:
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Please read our Contributing Guidelines for more details.
This project is licensed under the MIT License - see the LICENSE file for details.
- GTK for the GUI toolkit
- WebKit for web content rendering
- All our amazing contributors
Q: How does File Explorer compare to native file managers?
A: File Explorer aims to provide a lightweight, cross-platform alternative with a focus on performance and extensibility. While it may not have all the features of native file managers, it offers a customizable experience that can be tailored to specific needs.Q: Can I use File Explorer on Windows?
A: Currently, File Explorer supports Linux and macOS. Windows support is on our roadmap and we welcome contributions to make it happen!- Windows support
- Sidebar with pinned places and favorites
- Context menu for files/folders
- Plugin system for extensibility
- Cloud storage integration
File Explorer currently supports English. We're looking for contributors to help with translations! If you're interested, please check our Localization Guide.
We take security seriously. If you discover a security vulnerability, please send an e-mail to gfranklings@gmail.com. For more details, read our Security Policy.
For support, please open an issue on GitHub.
Love File Explorer? Let the world know!
AlphaTechnolog
- GitHub: @AlphaTechnolog
- Twitter: @AlphaTechnolog
Thanks to these wonderful people:
See CHANGELOG.md for more information on what has changed recently.
Made with ❤️ by AlphaTechnolog