kimlimjustin / xplorer

Xplorer, a customizable, modern file manager

Home Page:https://xplorer.vercel.app/

Github PK Tool:Github PK Tool

Repository from Github https://github.com/kimlimjustin/xplorerRepository from Github https://github.com/kimlimjustin/xplorer

xplorer's ContributorsOctNovDecJanFebMarAprMayJunJulAugSepOctSunMonTueWedThuFriSat

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

SupportsDiscussionsDocumentation

LICENSE Download Counts Stars Count Forks Count Watchers Count Issues Count Pull Request Count Follow Discord Server

Windows Support Ubuntu Support Arch Linux Support Windows Support


What is Xplorer?

Demo

View More Screenshots

Demo Demo Demo

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 Electron, and you can run it on Windows, MacOS, or Linux without having much trouble. One of the key feature is Xplorer allows you to preview the files you have directly inside Xplorer. And it's not only limited to picture or document preview, but also video preview.

To summarize, Xplorer's features contain:

  • It looks modern
  • Easy to use
  • Cross-platform
  • File Preview, even for videos!
  • 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 feedbacks in our Discussions page. If you feel comfortable in writing code using Typescript, we highly encourage you to contribute to this project.


Installation

If you want to install Xplorer in your system, you can download the installer for your operating system in 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 bug, please report it by submitting an issue in our issue page with detailed explanation. Giving some screenshots would also be very helpful.


Common Problems

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

Xplorer keep loading and crashes. Try open cmd by typing Win + R and type cmd. Enter following command:
wmic

If the output says the wmic is not recognized as internal or internal command, please follow the steps given on this article or this article.

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

Opening folder like Documents, Desktop, Downloads makes Xplorer crash

Disable the Extract exe file icon and make it as preview setting.

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

Xplorer is unstable after installing it. Simply restart, Xplorer will fix itself, if it doesn't, please address an issue over here

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

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

  3. Change directory to the root directory of this project

    $ cd xplorer

  4. Install all dependencies using yarn

    $ yarn install

  5. Run the project in development mode

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

Open in Gitpod


LICENSE

Apache-2.0

About

Xplorer, a customizable, modern file manager

https://xplorer.vercel.app/

License:Apache License 2.0


Languages

Language:TypeScript 77.0%Language:SCSS 6.8%Language:JavaScript 4.1%Language:C++ 3.7%Language:EJS 3.5%Language:CSS 3.2%Language:HTML 1.2%Language:Dockerfile 0.3%Language:Python 0.1%Language:Shell 0.0%