https://github.com/nwutils/nw-local-server-example
An example of using a local webserver in NW.js
https://github.com/nwutils/nw-local-server-example
Last synced: 3 months ago
JSON representation
An example of using a local webserver in NW.js
- Host: GitHub
- URL: https://github.com/nwutils/nw-local-server-example
- Owner: nwutils
- License: mit
- Created: 2017-09-10T20:06:53.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T23:00:24.000Z (6 months ago)
- Last Synced: 2025-01-13T11:24:26.051Z (5 months ago)
- Language: HTML
- Homepage: https://nwutils.io
- Size: 280 KB
- Stars: 22
- Watchers: 4
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# nw-local-server
An example of using a local webserver in NW.js
## How to run
1. Install [Node.js](http://nodejs.org) & npm (comes with Node)
1. Download or clone the repo
1. `npm install`
1. `npm start`
## How this works
1. `npm install` will download NW.js and Express to the `node_modules` folder.
1. `npm start` will Launch NW.js from your project's root.
1. NW.js will look at the `package.json` and see the `"node-main"` set to `server.js`. This will be the first thing NW.js runs and it runs this script in the "Node context" before a window is loaded.
1. The `server.js` runs and starts up an Express server on port 3000.
1. Next NW.js will look at the `package.json` and see the `"main"` set to `http://localhost:3000`. The `main` is usually set to `index.html`, it tells NW.js what is the first page to load for your app's UI. Since the Express server is already running NW.js will go to that URL and Express will return the `index.html` file.
1. The last step that NW.js does is look at the `package.json` and see the `"node-remote"` set to `http://localhost:3000`. The `node-remote` tells NW.js what URL's are allowed to run Node.js commands. With it pointing to the server you just started, your app can now run properly, accessing Node directly from the DOM.
1. From this point on you can create your app like you would in a regular browser. You can create folders for you images, styles, and scripts and link to them from your `index.html`. You can also access any Node modules you've installed in the project.
* * *
For a more detailed step-by-step tutorial of using NW.js to create your first desktop app, click here:
* [Laptop Battery NW.js App Tutorial](https://gitlab.com/TheJaredWilcurt/battery-app-workshop)