@nodegui/nodegui

nodegui

A cross platform library to build native desktop apps. Based on Qt5.

How does it look?

More screenshots?

See 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.
• (Partial support is present) Easily exstensible for creating custom native widgets (like react native).
• Support for flex box layouting using Yoga.
• Supports styling using css (includes actual cascading) or atleast useful subset of css properties.
• Complete Nodejs api support (Currently runs on Node v12 - and is easily upgradable).
• Can use all node compatible npm modules.
• Native widget event listener support.
• Should be usable for commercial applications aswell.
• (Partial) Should have a decent list of stylable native widgets.
• Easy build and packaging process.
• Good Devtools support (hot reload, live reload, debugging etc).
• Good documentation and website.
• Good documentation for contributors.
• Good support for dark mode (Thanks to QT).
• Typescript support

Docs for contributing

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 link:

https://github.com/master-atul/nodegui/tree/master/extras/devdocs

Building

yarn rebuild:addon [--qt_home_dir=/path/to/qt]

LICENSE

Since we do not in any way modify the code of Qt and only link to it dynamically, I beleive we are in compliance with the LGPL license requirements of QT. And hence this library can be licensed under its own License (for which we have chosen MIT License).
The links to QT source code and appropriate license notices are attached. We try our best to abide by the software licenses and any non compliance is not by will. If there is some discrepancy please let us know in the issues and we will try and fix it up.
If you follow the recommended build steps and do not statically link QT libraries on your own you are safe to use this library for commerical puropses (provided you abide by MIT License).

MIT

TODO

• Make https://github.com/nodegui/nodegui-starter