Skip to content

Latest commit

 

History

History
92 lines (63 loc) · 3.13 KB

README.md

File metadata and controls

92 lines (63 loc) · 3.13 KB
Raw

Introduction

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

It's created and developed in Intel Open Source Technology Center.

Introduction to node-webkit (slides).

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 runs 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 OSX and Windows

Downloads

v0.3.6 release note

Prebuilt binaries (v0.3.6 — Dec 14, 2012):

Looking for older versions?

You may also be interested in our demos repository and the List of apps and companies using node-webkit.

Quick Start

Create index.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",
  "main": "index.html"
}

Compress index.html and package.json into a zip archive, and rename it to app.nw:

app.nw
|-- package.json
`-- index.html

Download the prebuilt binary for your platform and use it to open the app.nw file:

$ ./nw app.nw

Note: on Windows, you can drag the app.nw to nw.exe to open it.

Documents

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

And our Wiki for much more.

Community

We use node-webkit group as our mailing list, subscribe via node-webkit+subscribe@googlegroups.com.

License

node-webkit's code uses the MIT license, see our LICENSE file.