https://github.com/nodegui/nodegui-starter

A starter repo for NodeGui projects
https://github.com/nodegui/nodegui-starter

cross-platform desktop gui nodejs qt

Last synced: 2 months ago
JSON representation

A starter repo for NodeGui projects

• Host: GitHub
• URL: https://github.com/nodegui/nodegui-starter
• Owner: nodegui
• Created: 2019-07-30T20:01:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-17T09:26:29.000Z (11 months ago)
• Last Synced: 2024-07-31T19:54:30.967Z (6 months ago)
• Topics: cross-platform, desktop, gui, nodejs, qt
• Language: TypeScript
• Size: 449 KB
• Stars: 123
• Watchers: 10
• Forks: 31
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-nodegui - NodeGui starter - A starter repo for NodeGui projects (Boilerplates / Samples and Experiments)

README

        
## :warning: This starter repository isn't being actively maintained. :point_right: Go to [nodegui-simple-starter](https://github.com/sedwards2009/nodegui-simple-starter) for a modern starter template.

# nodegui-starter

**Clone and run for a quick way to see NodeGui in action.**

## To Use

To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) 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:

```bash

# 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

```

## Resources for Learning NodeGui

- [docs.nodegui.org](https://nodegui.github.io/nodegui) - all of NodeGui and React Desktop's documentation

## Packaging app as a distributable

In order to distribute your finished app, you can use [@nodegui/packer](https://github.com/nodegui/packer)

### Step 1: (_**Run this command only once**_)

```sh

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.

### Step 2: (_**Run this command every time you want to build a new distributable**_)

Next you can run the pack command:

```sh

npm run build

```

This will produce the js bundle along with assets inside the `./dist` directory

```sh

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

## License

MIT