Skip to content

Starter repository for react based native desktop apps using react-nodegui

Notifications You must be signed in to change notification settings

LuisMerinoP/react-nodegui-starter

 
 

Repository files navigation

react-nodegui-starter

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

logo

To Use

To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
git clone https://github.com/nodegui/react-nodegui-starter
# Install CMake  
//brew install cmake
1.- Download from [here](https://cmake.org/download/) unzip and set the bin folder path as environment variable so that the cmake commmand works
2.- Enable Visual Studio c++ tools. With the visual stidio installer, modifiy the installation and add the c++ development tools
# 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

Packaging app as a distributable

In order to distribute your finished app, you can use @nodegui/packer

Step 1: (Run this command only once)

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:

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

License

MIT

About

Starter repository for react based native desktop apps using react-nodegui

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 56.0%
  • TypeScript 44.0%