Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nodegui/nodegui
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
https://github.com/nodegui/nodegui
cross-platform desktop gui javascript nodejs openlibrary qt
Last synced: 6 days ago
JSON representation
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
- Host: GitHub
- URL: https://github.com/nodegui/nodegui
- Owner: nodegui
- License: mit
- Created: 2019-05-14T16:41:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T18:35:18.000Z (3 months ago)
- Last Synced: 2024-10-29T10:18:00.813Z (3 months ago)
- Topics: cross-platform, desktop, gui, javascript, nodejs, openlibrary, qt
- Language: C++
- Homepage: http://docs.nodegui.org
- Size: 92 MB
- Stars: 8,904
- Watchers: 94
- Forks: 294
- Open Issues: 79
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - nodegui - A library for building cross-platform native desktop applications with JavaScript and CSS like styling ๐. For React NodeGUI, visit: https://github.com/nodegui/react-nodegui โ๏ธ (C++)
- awesome-electron-alternatives - NodeGui - React](https://github.com/nodegui/react-nodegui), [Vue NodeGui](https://github.com/nodegui/vue-nodegui), [Svelte-NodeGui](https://github.com/nodegui/svelte-nodegui) (๐ Alternatives to the [Electron.js](https://electronjs.org) โ / Javascript)
- AwesomeCppGameDev - nodegui - platform native desktop applications with Node.js and CSS (Graphics)
- awesome-desktop-js - NodeGUI - a library powered by Qt5 for building cross-platform native desktop applications with JavaScript and CSS (GUI Frameworks / Qt)
- StarryDivineSky - nodegui/nodegui - ๅนถไธๆไบๅ็บง๏ผใๅ ๆญคๅฏไปฅ่ฎฟ้ฎๆๆไธ Nodejs ๅ ผๅฎน็ NPM ๆจกๅใ๏ผๆฌๆบๅฐ้จไปถไบไปถไพฆๅฌๅจๆฏๆใๆฏๆQt / NodeJsๆไพ็ๆๆไบไปถใ๏ผๅฏ็จไบๅไธๅบ็จ๏ผ่ฏๅฅฝ็ Devtools ๆฏๆ๏ผ่ฏๅฅฝ็ๆๆกฃๅ็ฝ็ซ๏ผไธบ่ดก็ฎ่ ๆไพ่ฏๅฅฝ็ๆๆกฃ๏ผๅฏนๆๆจกๅผ็่ฏๅฅฝๆฏๆ๏ผๆ่ฐขQt๏ผใ๏ผไธๆต็ Typescript ๆฏๆใ (ๅ็ซฏๅผๅๆกๆถๅ้กน็ฎ / ๅ ถไป_ๆๆฌ็ๆใๆๆฌๅฏน่ฏ)
- awesome-github-star - nodegui - platform native desktop applications with Node.js and CSS ๐. React NodeGui : https://react.nodegui.org and Vue NodeGui: https://vue.nodegui.org | nodegui | 8542 | (C++)
- awesome - nodegui - 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 (qt)
- awesome - nodegui - 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 (qt)
README
# NodeGui
[](#contributors)
[](https://changelog.com/jsparty/96)
[](https://github.com/nodegui/nodegui/actions)
[](https://github.com/nodegui/nodegui/discussions)
Build **performant**, **native** and **cross-platform** desktop applications with **Node.js** and **CSS like styling**.๐
NodeGUI is powered by **Qt6** ๐ 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.
## How does it look?
### Code Examples
https://github.com/nodegui/examples
---
## Features
- ๐งฌ **Cross platform.** Works 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 v16.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-simple-starter](https://github.com/sedwards2009/nodegui-simple-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
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.
## 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 from source
This section is useful for those wanting to work on NodeGui itself.
### Required tooling
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
```
### Building
Once you have cloned this git repository, run this to build:
```
npm install
npm run build
```
The last step will takes some time to run as it builds the C++ binaries at the core of NodeGui.
### 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 qt6
cd qt6
git checkout 6.6
./init-repository --module-subset=essential -f
git submodule init qtsvg
git submodule update qtsvg
cd ..
mkdir qt6-6.6-macOS-release
cd qt6-6.6-macOS-release
../qt6/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-6.6.0` (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-6.6.0`. 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`.
### Running example programs
A number of small programs to show different parts of the Qt API are in `src/examples`. They can be run directly with:
```
npm run qode dist/examples/modelview_1_readonly.js
```
## 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.
ย ย 
## 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
John Susek
Marc Dijoux
Stephen Belanger
Rustam
## Maintainers โจ
People maintaining this project.
## 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!
