Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nodegui/react-nodegui-starter
Starter repository for react based native desktop apps using react-nodegui
https://github.com/nodegui/react-nodegui-starter
desktop gui native nodejs qt react
Last synced: about 1 month ago
JSON representation
Starter repository for react based native desktop apps using react-nodegui
- Host: GitHub
- URL: https://github.com/nodegui/react-nodegui-starter
- Owner: nodegui
- Created: 2019-07-30T18:27:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-15T09:42:08.000Z (over 1 year ago)
- Last Synced: 2024-07-31T19:41:47.098Z (4 months ago)
- Topics: desktop, gui, native, nodejs, qt, react
- Language: JavaScript
- Homepage:
- Size: 911 KB
- Stars: 172
- Watchers: 7
- Forks: 31
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-nodegui - React NodeGui starter - Starter repository for react based native desktop apps using react-nodegui (Boilerplates / Samples and Experiments)
README
# react-nodegui-starter
**Clone and run for a quick way to see React 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. From your command line:
```bash
# Clone this repository
git clone https://github.com/nodegui/react-nodegui-starter
# Install CMake
brew install cmake
# Go into the repository
cd react-nodegui-starter
# Install dependencies
npm install
# Run the dev server
npm run dev
# Open andother terminal and run the app
npm start
```
## Installation & Resources for learning React NodeGui
- [Documentation](https://react.nodegui.org) - all of React NodeGui's documentation.
- [NodeGui](https://nodegui.org) - all of NodeGui'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