Build performant, native and cross-platform desktop applications with Node.js and CSS like styling.
NodeGUI is powered by Qt5
If you are looking for React based version, check out: React NodeGUI.
Visit: https://nodegui.github.io/nodegui for docs.
How does it look?
🧬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 .
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/
brew install cmake brew install make
sudo apt-get install pkg-config build-essential sudo apt-get install cmake make
Then install NodeGui from your command line:
To install latest stable release:
npm install @nodegui/nodegui
To install the latest version available on master branch:
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
- 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.
Docs for contributing
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.
npm run build
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.
Code of Conduct
Thanks goes to these wonderful people.
People maintaining this project.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!