/qian

A minimalist file-explorer using Electron via Elm !
  1. Elm 71.7%
  2. JavaScript 15.2%
  3. CSS 11.4%
  4. Other 1.7%
Switch branches/tags
Nothing to show
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
branding Append image Nov 27, 2017
dist first commit Nov 7, 2017
src Change title bar ! Dec 18, 2017
static bump to electron 1.7.11 (for security) Jan 23, 2018
.gitignore Add zip in the gitignore Dec 14, 2017
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Nov 13, 2017
CONTRIBUTING.md Create CONTRIBUTING.md Nov 13, 2017
ISSUE_TEMPLATE.md Create ISSUE_TEMPLATE.md Nov 13, 2017
LICENSE first commit Nov 7, 2017
Makefile Change keyboard and add zip in the Makefile Dec 14, 2017
README.md Change readme and version Dec 14, 2017
elm-package.json Use Simple.Fuzzy to search through files tree Nov 16, 2017
icon.icns Add icon ! Dec 1, 2017
icon.ico Add icon ! Dec 1, 2017
main.js Change title bar ! Dec 18, 2017
package-lock.json bump to electron 1.7.11 (for security) Jan 23, 2018
package.json bump to electron 1.7.11 (for security) Jan 23, 2018
webpack.config.js Append "open in terminal" Nov 15, 2017

README.md

Qian (wip)

Qian is an hackable micro File explorer for OSX, written in Elm and Electron. The name Qian come from the name of Zhang Qian, a Chinese explorer. (aha get it ?)

Tl;dr

Sample

Since I'm on Mac, I mainly use the terminal to navigate my files because I do not like much Finder (I don't really have any arguments ...). So I decided to build a small file explorer (mainly to navigate my documents) that would fit perfectly to my needs.

I used Elm because I wanted to learn how to use it, and Electron because I want to prototype quickly.

Philosophy

The main goal of this project is not to create a revolutionary software. Just build a useful software for me. The idea is to implement features only when I need them.

If you see any changes to the code, do not hesitate to make an issue or pull-request! In addition, if a feature seems interesting to implement, let's talk about it in an issue!

Usage

  • npm install -g elm (to install Elm)
  • make install to fetch the NPM dependancies
  • make build to build the application
  • make run to run the buildt application
  • make (a combo of make build and make run)
  • make app to create a runnable app on OSX

Shortcuts

  • Tab : toggle the focus on the searchbar
  • Cmd + Alt + Enter : Open the current folder in finder
  • Cmd + Enter : Open the current folder in a terminal
  • Cmd + < : Go on the pred view (if it exists)
  • Cmd + > : Go on the next view (if it exists)
  • Cmd + Shift + Space : Go to the parent (if it exists)

About the search bar

Using Tab you can toggle the search-bar activation. When you write text into this bar, the content of the folder will be filtered using a fuzzy-filtering. If you write /, Qian will open the first element of the result of the filtering.

Credits

  • @radmen: add the support of Fuzzy-Search (using a NoRedink's package)
  • @julien-leclercq: Makefile improvement
  • @xvw: everything else... (I think :P)

Tools