Go to file

Atul R f0d6cd5f8c Merge pull request #114 from nodegui/cleanup/ng Adds target versioning		2019-09-22 17:20:39 +02:00
.github	Update issue templates	2019-09-07 10:49:19 +02:00
config	Adds target versioning"	2019-09-22 17:19:41 +02:00
docs	Merge pull request #106 from kant/patch-2	2019-09-21 22:05:25 +02:00
extras	Update thanks.md	2019-09-08 08:20:26 +02:00
plugin	Adds include and linkings for plugins	2019-09-22 14:24:46 +02:00
src	Adds include and linkings for plugins	2019-09-22 14:24:46 +02:00
.all-contributorsrc	docs: update .all-contributorsrc	2019-09-20 21:04:40 +00:00
.gitignore	Upgrade Yoga to latest	2019-07-23 23:34:36 +02:00
CMakeLists.txt	Adds target versioning"	2019-09-22 17:19:41 +02:00
LICENSE	Initial commit	2019-05-14 18:41:18 +02:00
package-lock.json	Adds cmake build support	2019-09-20 23:41:11 +02:00
package.json	Adds include and linkings for plugins	2019-09-22 14:24:46 +02:00
README.md	docs: update README.md	2019-09-20 21:04:39 +00:00
tsconfig.json	Cleans up addon import	2019-09-21 00:05:46 +02:00

README.md

NodeGUI

Build performant, native and cross-platform desktop applications with JavaScript + powerful 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.

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 😉).

Current focus:

(Partial support is present) Easily exstensible for creating custom native widgets (like react native).
(Partial) Should have a decent list of stylable native widgets.
Easy build and packaging process.

Getting Started

Check out nodegui-starter to get up and running with your own React NodeGUI app!
Read through the docs.

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.

Building

npm run build [--qt_home_dir=/path/to/qt]

Funding

NodeGUI is an open source project and requires your support. If you like this project, please consider supporting my work with 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.

License

MIT

Maintainers ✨

People maintaining this project.

_{Atul R}

Contributors ✨

Thanks goes to these wonderful people (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} 💻

This project follows the all-contributors specification. Contributions of any kind welcome!