erickwang / xplorer

Xplorer, a customizable, modern file manager

Xplorer, a customizable, modern and cross-platform File Explorer.

Supports • Discussions • Documentation • Discord

---

What is Xplorer?

View More Screenshots

Xplorer is a file explorer built from ground-up to be fully customizable. And even without any customization, it already looks modern!

Xplorer is a cross-platform application built using Tauri, and you can run it on Windows, MacOS, or Linux without having much trouble. One of the key features is Xplorer allows you to preview the files you have directly inside Xplorer. And it's not only limited to picture or document previews, but also video previews.

To summarize, Xplorer's features contain:

• It looks modern
• Easy to use
• Cross-platform
• File Preview, even for videos!
• Customizable
• Supports multiple tabs
• Most importantly, Free and Open Source Software(FOSS), which means you can change components inside if you see fit

Xplorer is currently under heavy development. You can give your suggestions and feedback on our Discussions page. If you feel comfortable in writing code using Typescript and Rust, we highly encourage you to contribute to this project.

---

Installation

If you want to install Xplorer on your system, you can download the installer for your operating system on the release page. Please note that the current version is not stable yet, and you may encounter various bugs.

---

Bug Reporting

If you find any bugs, please report it by submitting an issue on our issue page with a detailed explanation. Giving some screenshots would also be very helpful.

Feature Request

You can also submit a feature request on our issue page or discussions and we will try to implement it as soon as possible. If you want to contribute to this project, please contribute to this project.

---

Common Problems

NB: For common installation problems, please visit this page here

Opening folders like Documents, Desktop, Downloads makes Xplorer crash

Try disabling the Extract exe file icon and make it as preview option on Preference page on Settings.

Also, please make sure that Windows Defender isn't blocking Xplorer from accessing your documents.

Xplorer crashes when opening a folder.

Simply close and reopen Xplorer, Xplorer will fix itself. If it doesn't, please address an issue over here

---

Architecture

Xplorer is a cross-platform application built using the Tauri framework. Tauri is based on Microsoft Edge-similar webview and Rust to work. Read about tauri here

Xplorer is a polygot application. Xplorer relies on Rust api for file operations and TS, SCSS for the webview. Rust code are under src-tauri directory whereas the webview code are under src directory. The API that connects webview with the Rust code is under src/Api directory.

---

Development

If you want to run this project in your local system, please follow this guide:

1. Fork this project

2. Clone the project to your local system using this command

3. Follow this guide to set up Tauri environment

$ git clone https://github.com/<your_github_username>/xplorer.git

4. Change directory to the root directory of this project

$ cd xplorer

5. Install all dependencies using yarn

$ yarn install

6. Run the project in development mode. Please note that it might takes some times for Cargo to install dependencies for the first run.

$ yarn dev

---

Contribution Guide

We highly encourage you to contribute to this project (even if you are a beginner). And if you finally want to contribute to this project, please read our contribution guide.

---

Gitpod for Xplorer's development

Gitpod is a Ready-to-Code environment in which you don't need to worry about dependency errors or lagging your computer. Hit the button below and log in to GitHub with your GitHub account. Then, after it loads, you end up with a VS Code-like environment where you can start developing and pushing your changes.

Very Important Note: Remember to reload the Gitpod website after it loads up since it won't start the servers immediately, but by reloading, you can get it started. If you are developing the app, go to the Remote Explorer on the sidebar and visit port 6080 which opens the noVNC app server. If you are developing the docs, go to the Remote explorer but instead of port 6080, visit port 3000. You can edit normally as you do in VS Code, but if you want to use it locally, click the hamburger menu button and click Open in VS Code.

---

LICENSE

Apache-2.0