NodeGui


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.
How does it look?
More screenshots?
More Examples:
https://github.com/nodegui/examples
Features
- 𧬠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 π).
Getting Started
Installation
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:
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
Community guides
Talks/Podcasts
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.
Please read https://github.com/nodegui/.github/blob/master/CONTRIBUTING.md
Building
npm run build
Optionally set QT_INSTALL_DIR='/path/to/qt'
environment variable to build using your own version of Qt.
Updating docs
npm run docs
then followed by:
cd website && GIT_USER=<your_git_username> yarn deploy
Funding
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.
Β Β
Special Thanks
Code of Conduct
https://github.com/nodegui/.github/blob/master/CODE_OF_CONDUCT.md
License
MIT
Backers π
Thanks goes to these wonderful people.
Maintainers β¨
People maintaining this project.
Contributors β¨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!