Skip to content

Commit

Permalink
Merge pull request #2 from nwutils/main
Browse files Browse the repository at this point in the history
Tweaks from  @TheJaredWilcurt
  • Loading branch information
jonlepage committed Oct 26, 2020
2 parents 8eb7ab5 + 54b553f commit 04304a1
Show file tree
Hide file tree
Showing 6 changed files with 8,966 additions and 104 deletions.
47 changes: 47 additions & 0 deletions README.md
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
Loading

0 comments on commit 04304a1

Please sign in to comment.