🗂️ File Explorer

A modern file explorer built with C89 and vanilla JavaScript, featuring a custom template engine.

Features • Installation • Usage • Contributing • License

Table of contents

TOC

• 🌟 Project Overview
• ✨ Features
• 🚀 Getting Started
  • 📋 Prerequisites
  • ⚙️ Installation
• 🖥️ Usage
• 🛠️ Development
  • 🧪 Running Tests
• 🤝 Contributing
• 📜 License
• 👏 Acknowledgments
• ❓ FAQ
• 🔮 Roadmap
• 📊 Project Stats
• 🌐 Localization
• 🔒 Security
• 💼 Support
• 🔗 Related Projects
• 📣 Spread the Word
• 👤 Author
• 🏆 Contributors
• 📝 Changelog

🌟 Project Overview

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.

✨ Features

• 🚀 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

🚀 Getting Started

📋 Prerequisites

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

⚙️ Installation

1. Clone the repository:

git clone https://github.com/AlphaTechnolog/file-explorer.git
cd file-explorer

2. Initialize submodules:

git submodule update --init --recursive

3. 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 webkit2gtk instead of webkitgtk-6.0.

4. Build the project:

make

After successful compilation, you'll find the file-explorer binary in the project root.

🖥️ Usage

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-explorer

This command will open the File Explorer application in your terminal.

🤝 Contributing

We welcome contributions to File Explorer! Here's how you can help:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📜 License

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

👏 Acknowledgments

• GTK for the GUI toolkit
• WebKit for web content rendering
• All our amazing contributors

❓ FAQ

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!

🔮 Roadmap

• Windows support
• Sidebar with pinned places and favorites
• Context menu for files/folders
• Plugin system for extensibility
• Cloud storage integration

📊 Project Stats

🌐 Localization

File Explorer currently supports just English. Contributors are welcome to help with more languages!

🔒 Security

We take security seriously. If you discover a security vulnerability, please send an e-mail to [email protected].

💼 Support

For support, please open an issue on GitHub.

🔗 Related Projects

• Harakara Terminal

📣 Spread the Word

Love File Explorer? Let the world know!

👤 Author

AlphaTechnolog

• GitHub: @AlphaTechnolog
• Twitter: @alpha_technolog

🏆 Contributors

Thanks to these wonderful people:

---

Made with ❤️ by AlphaTechnolog