SULU

A </hackable> [package-driven] File Manager {CROSS_PLATFORM}

Installation

• One Click Install
  • Recommended way is to download and execute precompiled applications for different operating systems from latest releases. After that update the packages. Done. If your operating system is not in List you can build your own release. Open the package.json and checkout the script build-windows to learn how create a build job for your os. Currently we use electron-builder but there are tons of other build tools online. We like Pull Requests when you resolve a build for your OS!
• If you like to hack the SULU codes we recommend the Contributing Docs

Packages

Since SULU is a package driven application there exists a command line shell tool called sulu-core. It aims to manage the SULU system configuration which also containts the topic package management.

Packagemanager

You can install the SULU package manager with npm. To make it available on your machine you need to install Node.js® first.

$ npm install -g sulu-core

Packagemanager usage

Currently a typical update process is:

$ sulu-core outdated # list available updates
$ sulu-core update # update all packages
# press ctrl+f5 to refresh SULU application

More commands:

$ sulu-core list # list installed packages
$ sulu-core install @npmpackage # install package
$ sulu-core uninstall @npmpackage # uninstall package
# sulu-core <npm-command-line-arguments>

For more Details see the sulu-core project page.

Contributing

If you like to fix or improve SULU or create your own package for SULU read the Contributing Docs first.

Write your own package

1. Create a simple node module in the app node_modules folder with the following structure.

var remote = require('electron').remote;

var Command = function  () {
	return this;
};

Command.prototype.toggleDevTools = function toggleDevTools() {

	remote.getCurrentWindow().toggleDevTools();
	return false
};

var Plugin = function devTools(client) {
	this.command = new Command();
	client.app.registerHotKey("f12", this.command.toggleDevTools);
};

module.exports = Plugin;

2. Create a valid package.json with a property "suluPackage": true.

More to read

• The preinstalled package that handles the delete process of SULU.
• Study pre-installed and featured packages to learn what is possible.
• Read the SULU API Docs to use SULU core methods.
• Read the Electron Documentation to use the Electron API.
• And then write a cool piece of code :sunglasses:

More docs

• Key Bindings
• Documents Index

License

This project is MIT Licensed