Skip to content
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++ TypeScript Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
config
docs
examples
extras
src
.all-contributorsrc
.gitignore
CMakeLists.txt
LICENSE
README.md
package-lock.json
package.json
tsconfig.json

README.md

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

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

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.

Buy Me a Coffee at ko-fi.com     issuehunt

Special Thanks

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!

You can’t perform that action at this time.