A library for building cross-platform native desktop applications with Node.js and CSS π. React NodeGui : https://react.nodegui.org and Vue NodeGui: https://vue.nodegui.org
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.
If you are looking for React based version, check out: React NodeGUI.
If you are looking for Vue based version, check out: Vue NodeGUI.
Visit: https://nodegui.github.io/nodegui for docs.
More screenshots?
https://github.com/nodegui/examples
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 (Debian/Ubuntu)
sudo apt-get install pkg-config build-essential sudo apt-get install cmake make sudo apt-get install mesa-common-dev libglu1-mesa-dev
Linux (Fedora/RHEL/CentOS)
sudo dnf groupinstall "Development Tools" "Development Libraries" sudo dnf groupinstall "C Development Tools and Libraries" sudo dnf install mesa-libGL mesa-libGL-devel
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
If the installation fails to download the Qt binaries, a mirror can be used by setting the following environment variable and running the install command again:
QT_LINK_MIRROR= # eg. QT_LINK_MIRROR=https://qt-mirror.dannhauer.denpm install @nodegui/nodegui
See FAQs for more details.
Community guides
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= 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/CODEOFCONDUCT.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!