# NodeGui [![Join the NodeGUI community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/nodegui) [![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors) [![JS Party #96](https://img.shields.io/badge/JS%20Party-%2396-FFCD00.svg)](https://changelog.com/jsparty/96) [![Build and Test status](https://github.com/nodegui/nodegui/workflows/.github/workflows/test.yml/badge.svg)](https://github.com/nodegui/nodegui/actions) 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](https://github.com/nodegui/react-nodegui)**. If you are looking for **Vue** based version, check out: **[Vue NodeGUI](https://github.com/nodegui/vue-nodegui)**. If you are looking for **Svelte** based version, check out: **[Svelte NodeGUI](https://github.com/nodegui/svelte-nodegui)** Visit: https://nodegui.github.io/nodegui for docs. logo ## How does it look?
demo_linux demo_win demo_mac
kitchendemo_macdemo_win
**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 - Check out [nodegui-starter](https://github.com/nodegui/nodegui-starter) to get up and running with your own React NodeGUI app! - Read through the [docs](https://nodegui.github.io/nodegui). - Checkout the examples: https://github.com/nodegui/examples . - [Tutorial: Build a native Meme Search Desktop app with Javascript (NodeGui) and Giphy API](https://www.sitepoint.com/build-native-desktop-gif-searcher-app-using-nodegui/) ## 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 ``` 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: ```sh QT_LINK_MIRROR= # eg. QT_LINK_MIRROR=https://qt-mirror.dannhauer.de npm install @nodegui/nodegui ``` See [FAQs](https://github.com/nodegui/nodegui/tree/master/website/docs/faq.md#why-does-installation-fail-at-minimal-qt-setup) for more details. #### Using your own custom Qt installation (Optional) **Compiling Qt from source** You will need to download and install Qt from source since there are no binaries from Qt for M1 yet. (https://www.reddit.com/r/QtFramework/comments/ll58wg/how_to_build_qt_creator_for_macos_arm64_a_guide/) ``` git clone git://code.qt.io/qt/qt5.git cd qt5 git checkout 5.15 ./init-repository --module-subset=essential -f git submodule init qtsvg git submodule update qtsvg cd .. mkdir qt5-5.15-macOS-release cd qt5-5.15-macOS-release ../qt5/configure -release QMAKE_APPLE_DEVICE_ARCHS=arm64 -opensource -confirm-license -nomake examples -nomake tests -skip qt3d -skip webengine -skip qtactiveqt -skip qtcanvas3d -skip qtdeclarative -skip qtdatavis3d -skip qtdoc -skip qtgamepad -skip qtcharts -skip qtgraphicaleffects -skip qtlocation -skip qtpurchasing -skip qtquickcontrols -skip qtquickcontrols2 -skip qtremoteobjects -skip qtscxml -skip qtsensors -skip qtserialbus -skip qtserialport -skip qtspeech -skip qtvirtualkeyboard -skip qtscript make -j15 make install ``` This should install Qt into something like this `/usr/local/Qt-5.15.3` (your directory can change. This will be displayed when running make) **Pointing nodegui to use your custom Qt installation** Now just set `export QT_INSTALL_DIR=` . In the above example it would look something like this `export QT_INSTALL_DIR=/usr/local/Qt-5.15.3`. Add this in your .zshrc or .bashrc so that you dont need to repeat this process again. Now just `rm -rf node_modules` and do `npm install` again. The logs should say something like `CustomQt detected at . Hence, skipping Mini Qt installation`. **Community guides** - [Tutorial: Build a native Meme Search Desktop app with Javascript (NodeGui) and Giphy API](https://www.sitepoint.com/build-native-desktop-gif-searcher-app-using-nodegui/) - https://blog.logrocket.com/electron-alternatives-exploring-nodegui-and-react-nodegui/ - Electron alternatives: Exploring NodeGUI and React NodeGUI by [Siegfried Grimbeek](https://blog.logrocket.com/author/siegfriedgrimbeek/). - https://hibbard.eu/node-gui/ - Excellent guide from [James Hibbard](https://github.com/jameshibbard). **Talks/Podcasts** - [NodeGui and React NodeGui at KarmaJS Nov 2019 meetup: https://www.youtube.com/watch?v=8jH5gaEEDv4](https://www.youtube.com/watch?v=8jH5gaEEDv4) -

JS Party 96: Performant Node desktop apps with NodeGUI – Listen on Changelog.com

## 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](https://github.com/nodegui/nodegui/tree/master/website/docs/development). 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= 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.

Buy Me a Coffee at ko-fi.com    issuehunt

## Special Thanks - [Logo: Thanks to Vishwas Shetty from the Noun Project.](https://github.com/nodegui/nodegui/blob/master/extras/legal/logo/thanks.md) ## Code of Conduct https://github.com/nodegui/.github/blob/master/CODE_OF_CONDUCT.md ## License MIT ## Backers πŸš€ Thanks goes to these wonderful people.
Yuriy Yazlovytskyy
Yuriy Yazlovytskyy
John Susek
John Susek
Marc Dijoux
Marc Dijoux
Stephen Belanger
Stephen Belanger
Rustam
Rustam
## Maintainers ✨ People maintaining this project.
Atul R
Atul R
## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

Lucas Ramage

πŸ“–

Denis Sikuler

πŸ“–

Nahuel JosΓ©

πŸ’¬

Kakul Gupta

πŸ’»

Rahul Gaba

πŸ’»

PaweΕ‚ Borecki

πŸ’»

Marcus S. Abildskov

⚠️

Átila Camurça Alves

πŸ“–

James Hibbard

πŸ’»

Soonwoo Hong

πŸ’»

Roy Sommer

πŸ’»

Paulo Coghi

πŸ€”

Balthild Ires

πŸ’»

Dimitar Nestorov

πŸ’»

Mikko Sairio

πŸ’»

Pepijn

πŸ’»

slidinghotdog

πŸ’»

Bundyo (Kamen Bundev)

πŸ’»

feng8848

πŸ’»

Maksim Karelov

πŸ’»

mspencer92

πŸ’»

blncd2020

πŸ“–

gluaxspeed

πŸ’»

Solant

πŸ’»

Shubham Zanwar

πŸ’»

Singha360

πŸ’»

Mihkel

πŸ’»

Stephen A

πŸ’»

桁君酱

πŸ’»

Adam Gastineau

πŸ’»

swittk

πŸ’»

craftingmod

πŸ’»

Doug Barbieri

πŸ’»

HENRIQUE DE SOUZA NERY

πŸ’»

Ruslan Garifullin

πŸ’»

Ranieri

πŸ’» πŸ“–

Nathanael Anderson

πŸ’»

Ross

πŸ’» πŸ“–

4h7l

πŸ’»

Maks

πŸ’»

zhb124404

πŸ“–

Wyatt Kirby

πŸ’»

Steven Koch

πŸ’»

Simon Edwards

πŸ’»
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!