Skip to content

File explorer made with c89 and web tecnologies as frontend

Notifications You must be signed in to change notification settings

Obed0101/file-explorer

 
 

Repository files navigation

๐Ÿ—‚๏ธ File Explorer

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

Features โ€ข Installation โ€ข Usage โ€ข Contributing โ€ข License

GitHub stars GitHub forks GitHub watchers

License Issues Pull Requests

Table of contents

TOC


๐ŸŒŸ 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
  1. Initialize submodules:
git submodule update --init --recursive
  1. 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.

  1. 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.

๐Ÿ› ๏ธ Development

๐Ÿงช Running Tests

To run the test suite:

make test

๐Ÿค 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

Please read our Contributing Guidelines for more details.

๐Ÿ“œ License

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

๐Ÿ‘ Acknowledgments

โ“ 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 English. We're looking for contributors to help with translations! If you're interested, please check our Localization Guide.

๐Ÿ”’ Security

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.

๐Ÿ’ผ Support

For support, please open an issue on GitHub.

๐Ÿ”— Related Projects

๐Ÿ“ฃ Spread the Word

Love File Explorer? Let the world know!

๐Ÿ‘ค Author

AlphaTechnolog

๐Ÿ† Contributors

Thanks to these wonderful people:

๐Ÿ“ Changelog

See CHANGELOG.md for more information on what has changed recently.


Made with โค๏ธ by AlphaTechnolog

About

File explorer made with c89 and web tecnologies as frontend

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C 51.1%
  • JavaScript 23.4%
  • HTML 20.7%
  • Makefile 4.5%
  • Shell 0.3%