Skip to content

/nw.js

Call all Node.js modules directly from DOM and enable a new way of writing applications with all Web technologies.
  1. C++ 75.9%
  2. Objective-C++ 7.3%
  3. Python 6.4%
  4. JavaScript 5.7%
  5. HTML 2.5%
  6. Objective-C 1.6%
  7. Other 0.6%
C++ Objective-C++ Python JavaScript HTML Objective-C Other
Find file
Download ZIP
Latest commit ab2d078 @rogerwang rogerwang bump version to 0.13.0-rc5
Failed to load latest commit information.
.github Fix typo in issue template
docs [docs] update Command Line options with full list
patch build ffmpeg as Dll
src bump version to 0.13.0-rc5
test [test] disable additional_trust_anchors
tools [WIN] dump node.dll symbols
.gitignore test support and new cases
AUTHORS [Transparency] javascript / idl for all platform
BACKERS.md add BACKERS.md
CHANGELOG.md [CHANGELOG] 0.13.0-rc4
LICENSE Updated year in licence
README.md [README] 0.13.0-rc3
mkdocs.yml [docs] List Chrome Extension APIs
nw.gypi [OSX] Fix #4450: remove symbol dumping action
requirements.txt Added docs for NW.js

README.md

node-webkit is renamed NW.js

Gitter
Official site: http://nwjs.io
Official documentation: http://docs.nwjs.io/
Announcement

Introduction

NW.js is an app runtime based on Chromium and node.js. You can write native apps in HTML and JavaScript with NW.js. It also lets you call Node.js modules directly from the DOM and enables a new way of writing native applications with all Web technologies.

It was created in the Intel Open Source Technology Center.

Introduction to node-webkit (slides)
Creating Desktop Applications With node-webkit
WebApp to DesktopApp with node-webkit (slides)
Essay on the history and internals of the project

Features

  • Apps written in modern HTML5, CSS3, JS and WebGL.
  • Complete support for Node.js APIs and all its third party modules.
  • Good performance: Node and WebKit run in the same thread: Function calls are made straightforward; objects are in the same heap and can just reference each other;
  • Easy to package and distribute apps.
  • Available on Linux, Mac OS X and Windows

Downloads

Demos and real apps

You may also be interested in our demos repository and the List of apps and companies using nw.js.

Quick Start

Create index.html:

<!DOCTYPE html>
<html>
  <head>
    <title>Hello World!</title>
  </head>
  <body>
    <h1>Hello World!</h1>
    We are using node.js <script>document.write(process.version)</script>.
  </body>
</html>

Create package.json:

{
  "name": "nw-demo",
  "version": "0.0.1",
  "main": "index.html"
}

Run: 

$ /path/to/nw .  (suppose the current directory contains 'package.json')

Note: on Windows, you can drag the folder containing package.json to nw.exe to open it.

Note: on OSX, the executable binary is in a hidden directory within the .app file. To run node-webkit on OSX, type:
/path/to/nwjs.app/Contents/MacOS/nwjs . (suppose the current directory contains 'package.json')

Documents

For more information on how to write/package/run apps, see:

And our Wiki for much more.

Community

We use the google group as our mailing list (use English only). Subscribe via nwjs-general+subscribe@googlegroups.com.

NOTE: Links to the old google group (e.g. https://groups.google.com/forum/#!msg/node-webkit/doRWZ07LgWQ/4fheV8FF8zsJ) that are no more working can be fixed by replacing node-webkit with nwjs-general (e.g https://groups.google.com/forum/#!msg/nwjs-general/doRWZ07LgWQ/4fheV8FF8zsJ).

Issues are being tracked here on GitHub.

License

node-webkit's code in this repo uses the MIT license, see our LICENSE file. To redistribute the binary, see How to package and distribute your apps

Sponsors

The work is being sponsored by:

Something went wrong with that request. Please try again.