Skip to content
A Hackable File Explorer built using Electron, React, and Flux
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app adding windows binaru Jun 2, 2015
config
images updating window title Jun 1, 2015
resources preparing release Jun 1, 2015
tasks
.editorconfig Initial commit Apr 25, 2015
.gitignore Initial commit Apr 25, 2015
LICENSE readme Jun 1, 2015
README.md readme updates Jun 2, 2015
gulpfile.js OSX release process ready Apr 26, 2015
package.json

README.md

Electron File Explorer

A file explorer built using Electron (formerly Atom Shell), with React + Flux. Download for OSX Download for Windows

Screenshot

Features

  • Browse through directories and open files.
  • Navigate to previous directories using the "Back" button.
  • Easily add your favorite directories to the sidebar.
  • Easily customizable via Javascript + Sass

Quick start

The only development dependency of this project is Node.js. So just make sure you have it installed. Then type few commands known to every Node developer...

git clone https://github.com/timotius02/electron-file-explorer.git
cd electron-file-explorer
npm install
npm start

Structure of the project

There are two package.json files:

1. For development

Sits on path: electron-file-explorer/package.json. Here you declare dependencies for the development environment and build scripts. This file is not distributed with real application!

Also here you declare wersion of Electron runtime you want to use:

"devDependencies": {
  "electron-prebuilt": "^0.24.0"
}

2. For the application

Sits on path: electron-file-explorer/app/package.json. This is real manifest of the application. Declare the app dependencies here.

Project's folders

  • app - code of your application goes here.
  • config - place for you to declare environment specific stuff.
  • build - in this folder lands built, runnable application.
  • releases - ready for distribution installers will land here.
  • resources - resources for particular operating system.
  • tasks - build and development environment scripts.

Notes for Development

Module loader

How about splitting your JavaScript code into modules? This project supports it by new ES6 syntax (thanks to esperanto). ES6 modules are translated into AMD (RequireJS) modules. The main advantage of this setup is that you can use ES6/RequireJS for your own modules, and at the same time have normal access to node's require() to obtain stuff from npm.

// Modules you write are required through new ES6 syntax
// (It will be translated into AMD definition).
import myOwnModule from './my_own_module';
// Node.js (npm) modules are required the same way as always
// (so you can still access all the goodness in npm).
var moment = require('moment');
You can’t perform that action at this time.