Clone and run for a quick way to see NodeGui in action.
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer.
Make sure you have met the requirements listed here: https://docs.nodegui.org/docs/guides/getting-started#developer-environment
From your command line:
# Clone this repository
git clone https://github.com/nodegui/nodegui-starter
# Go into the repository
cd nodegui-starter
# Install dependencies
npm install
# Run the app
npm start
- docs.nodegui.org - all of NodeGui and React Desktop's documentation
In order to distribute your finished app, you can use @nodegui/packer
npx nodegui-packer --init MyAppName
This will produce the deploy directory containing the template. You can modify this to suite your needs. Like add icons, change the name, description and add other native features or dependencies. Make sure you commit this directory.
Next you can run the pack command:
npm run build
This will produce the js bundle along with assets inside the ./dist
directory
npx nodegui-packer --pack ./dist
This will build the distributable using @nodegui/packer based on your template. The output of the command is found under the build directory. You should gitignore the build directory.
More details about packer can be found here: https://github.com/nodegui/packer
MIT