Build performant, native and cross-platform desktop applications with Node.js and CSS like styling.π
NodeGUI is powered by Qt5 π which makes it CPU and memory efficient as compared to other chromium based solutions like electron.
Visit: https://nodegui.github.io/nodegui for docs.
More screenshots?
https://github.com/nodegui/examples
- 𧬠Cross platform. Should work on major Linux flavours, Windows and MacOS.
- π Low CPU and memory footprint. Current CPU stays at 0% on idle and memory usage is under 20mb for a hello world program.
- π Styling with CSS (includes actual cascading). Also has full support for Flexbox layout (thanks to Yoga).
- β Complete Nodejs api support (Currently runs on Node v12.x - and is easily upgradable). Hence has access to all nodejs compatible npm modules.
- πͺ Native widget event listener support. Supports all events available from Qt / NodeJs.
- πΈ Can be used for Commercial applications.
- π΅οΈββοΈ Good Devtools support.
- π Good documentation and website.
- π§ββοΈ Good documentation for contributors.
- π¦Ήπ»ββοΈ Good support for dark mode (Thanks to Qt).
- π First class Typescript support. (Works on regular JS projects too π).
- Check out nodegui-starter to get up and running with your own React NodeGUI app!
- Read through the docs.
- Checkout the examples: https://github.com/nodegui/examples .
- Tutorial: Build a native Meme Search Desktop app with Javascript (NodeGui) and Giphy API
NodeGui requires CMake and Compilation Tools as it is a wrapper for a native C++ widget toolkit QT. Detailed instructions here: https://www.sitepoint.com/build-native-desktop-gif-searcher-app-using-nodegui/
TL;DR: MacOS
brew install cmake
brew install make
Windows https://cmake.org/download/
Linux
sudo apt-get install pkg-config build-essential
sudo apt-get install cmake make
sudo apt-get install mesa-common-dev libglu1-mesa-dev
Then install NodeGui from your command line:
npm install @nodegui/nodegui
npm install https://github.com/nodegui/nodegui/releases/download/v0.0.0-latest-master/nodegui-master.tgz
or a shorter version:
npm i http://master-release.nodegui.org
Community guides
- Tutorial: Build a native Meme Search Desktop app with Javascript (NodeGui) and Giphy API
- https://blog.logrocket.com/electron-alternatives-exploring-nodegui-and-react-nodegui/ - Electron alternatives: Exploring NodeGUI and React NodeGUI by Siegfried Grimbeek.
- https://hibbard.eu/node-gui/ - Excellent guide from James Hibbard.
Talks/Podcasts
-
NodeGui and React NodeGui at KarmaJS Nov 2019 meetup: https://www.youtube.com/watch?v=8jH5gaEEDv4
-
JS Party 96: Performant Node desktop apps with NodeGUI β Listen on Changelog.com
It is easier than you think, try it
Looking to contribute? If you wish to implement a new widget/add more features and need help understanding the codebase, you can start here: Contributing developer docs.
Please read https://github.com/nodegui/.github/blob/master/CONTRIBUTING.md
npm run build
Optionally set QT_INSTALL_DIR='/path/to/qt' environment variable to build using your own version of Qt.
npm run docs
then followed by:
cd website && GIT_USER=<your_git_username> yarn deploy
NodeGui is an open source project and requires your support. If you like this project, please consider supporting my work by clicking on the Sponsor button on this Github repository or via Ko-Fi. Alternatively, Issues on NodeGui can be funded by anyone via Issuehunt and the amount will be distributed to respective contributors.
https://github.com/nodegui/.github/blob/master/CODE_OF_CONDUCT.md
MIT
Thanks goes to these wonderful people.
 Yuriy Yazlovytskyy |
 John Susek |
 Marc Dijoux |
 Stephen Belanger |
 Rustam |
People maintaining this project.
 Atul R |
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!