plastichub/nodeguy
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
172 Commits 4 Branches 110 Tags 90 MiB
C++ 65.3%
TypeScript 31.1%
JavaScript 2.2%
CMake 1.3%
CSS 0.1%
61c7361a11
Go to file
Atul R 61c7361a11 Added doc plugins
2019-08-03 17:02:55 +02:00
.github Update FUNDING.yml 2019-07-30 23:29:49 +02:00
config Adds documentation for all internal widgets. 2019-08-02 22:46:03 +02:00
deps Upgrade Yoga to latest 2019-07-23 23:34:36 +02:00
docs Added doc plugins 2019-08-03 17:02:55 +02:00
examples/calculator Added logo 2019-07-27 13:28:43 +02:00
extras moved docs to top level 2019-07-30 22:51:21 +02:00
scripts Added automoc 2019-06-07 21:41:08 +02:00
src Adds flex layout documentation 2019-08-02 23:36:13 +02:00
.gitignore Upgrade Yoga to latest 2019-07-23 23:34:36 +02:00
binding.gyp Fix Yoga issue and reorder gypi files 2019-07-26 21:59:24 +02:00
demo.ts Adds base boilerplates similar to that of Electron 2019-07-29 23:31:03 +02:00
LICENSE Initial commit 2019-05-14 18:41:18 +02:00
package-lock.json remove dependency on docsify 2019-07-30 23:03:29 +02:00
package.json fix complete rebuild always. 2019-07-31 21:58:36 +02:00
README.md Updated setup guides 2019-08-03 00:46:26 +02:00
tsconfig.json Upgrade Yoga to latest 2019-07-23 23:34:36 +02:00

README.md

nodegui

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

logo

How does it look?

demo_linux demo_win demo_mac

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/docs/development

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