-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from nwutils/main
Tweaks from @TheJaredWilcurt
- Loading branch information
Showing
6 changed files
with
8,966 additions
and
104 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# NW.js Parcel HMR Boilerplate | ||
|
||
Boilerplate for Desktop App development using Parcel for Hot Module Reloading (HMR). | ||
|
||
|
||
## Features | ||
|
||
* Parcel Bundlers | ||
* Builds for all majors Browsers (Chrome, Edge, FireFox...) | ||
* Builds for all majors Desktops achhitectures (x86, x64, Windows, OSX, Linux...) | ||
* Hot reloading of browser and desktop (NW.js) | ||
* Node.js (Native with NW.js) | ||
|
||
|
||
|
||
## Environment setup | ||
|
||
1. Install [Node.js and npm](https://nodejs.org) | ||
1. Download, clone, or fork this repo | ||
1. Run `npm install` | ||
|
||
## Development | ||
|
||
* **Desktop App:** Local development | ||
* `npm run start-nw` | ||
* **Web App:** Local development, starts dev server | ||
* `npm start` | ||
|
||
|
||
## Build for production | ||
|
||
* **Desktop App:** Build final app for desktop (x64, x86, Windows, Linux, OSX) | ||
* `npm run build-nw` | ||
* **Web App:** Build final app for browsers | ||
* `npm run build` | ||
|
||
|
||
* * * | ||
|
||
|
||
# Documentation | ||
|
||
* Development will bundle app in `dist` folder. | ||
* Production will bundle app in `build` folder. | ||
* `src` folder is where you code your app | ||
* NW.js will be installed locally in `node_modules` | ||
* `package.json` inside `/public`, is where setup for the desktop development and build is stored |
Oops, something went wrong.