Development Kit

This is a project to create a development kit in nw.js (previously named node-webkit).

It is meant for organizations who want to have their own development kit. It is extremely modular, and making it suitable for your needs is easy.

Docs

The docs will be improved over time

Example app

An example app will be provided in the feature. For now, refer to Athom and Printr for examples.

Project

One project can be loaded at the same time. A project is a directory on the filesystem. The sidebar will show the folder's contents, and update the contents live.

Components

You can customize the devkit by loading components.

A component should be placed in ./app/components/(type)/(id)/ and loaded in ./app/app.js.

The files component.css, component.js and component.html are loaded when they exist. Additionally, you can auto-load js and css files by putting them in dependencies.

The following type of modules are allowed:

Editors editor

An editor is a single view that can edit files. By default, we ship CodeMirror as the default editor. You can override this behavior in your own app.

Widgets widget

Every open file can have multiple widgets loaded. A widget is a view-only block, that can display (for example) a preview.

By default we ship a markdown and svg widget.

Headers header

In the header bar, you can add custom elements. Examples are a "Run" button, user authentication, a title...

Themes theme

A theme can do anything to customize the devkit to your needs.

Popups popup

Popups can be registered as well, and can be shown from anywhere.

Contributing

Send a pull request to contribute! ❤