Skip to content
forked from nodegui/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 ⚛️

License

Notifications You must be signed in to change notification settings

jerodsanto/nodegui

 
 

Repository files navigation

NodeGUI

Join the NodeGUI community on Spectrum All Contributors

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.

logo

This project is in active development. It should be okay for smaller projects but anything complex - electron is the way to go for now. 🚧

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 to get up and running with your own React NodeGUI app!
  • Read through the docs.

Community guides

Talks/Podcasts

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.

Please read https://github.com/nodegui/.github/blob/master/CONTRIBUTING.md

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.

Buy Me a Coffee at ko-fi.com     issuehunt

Special Thanks

Code of Conduct

https://github.com/nodegui/.github/blob/master/CODE_OF_CONDUCT.md

License

MIT

Maintainers ✨

People maintaining this project.

Atul R
Atul R

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Lucas Ramage
Lucas Ramage

📖
Denis Sikuler
Denis Sikuler

📖
Nahuel José
Nahuel José

💬
Kakul Gupta
Kakul Gupta

💻
Rahul Gaba
Rahul Gaba

💻
Paweł Borecki
Paweł Borecki

💻
Marcus S. Abildskov
Marcus S. Abildskov

⚠️
Átila Camurça Alves
Átila Camurça Alves

📖
James Hibbard
James Hibbard

💻
Soonwoo Hong
Soonwoo Hong

💻
Roy Sommer
Roy Sommer

💻
Paulo Coghi
Paulo Coghi

🤔
Balthild Ires
Balthild Ires

💻

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

About

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 ⚛️

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 87.8%
  • TypeScript 8.6%
  • JavaScript 1.5%
  • CMake 1.1%
  • Other 1.0%