react-nodegui

by nodegui

nodegui / react-nodegui

Build performant, native and cross-platform desktop applications with native React + powerful CSS li...

4.9K Stars 110 Forks Last release: about 1 month ago (v0.9.0) MIT License 318 Commits 19 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

React NodeGui

Join the NodeGUI community on Spectrum All Contributors

Build performant, native and cross-platform desktop applications with React.πŸš€

React NodeGUI is powered by React βš›οΈ and Qt5 πŸ’š which makes it CPU and memory efficient as compared to other chromium based solutions like electron. React NodeGUI is essentially a React renderer for NodeGUI.

Visit: https://react.nodegui.org 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?

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.
  • πŸ’… 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 event available from Qt / NodeJs.
  • πŸ’Έ Can be used for Commercial applications.
  • πŸ•΅οΈβ€β™‚οΈ Good Devtools support (supports react-devtools, node debugger).
  • πŸ“š 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

Community Guides - https://gregbenner.life/node-gui-react-component-by-component/ - An awesome intro to all base components in react nodegui

  • https://blog.logrocket.com/electron-alternatives-exploring-nodegui-and-react-nodegui/ - Electron alternatives: Exploring NodeGUI and React NodeGUI by Siegfried Grimbeek.

Talks/Podcasts

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/nodegui/nodegui/tree/master/website/docs/development

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

Building

npm run build

Using custom Qt

QT_INSTALL_DIR=/path/to/qt npm install

npm run build

Updating docs

npm run docs

then followed by:

cd website &&  GIT_USER= yarn deploy

Funding

React NodeGUI is an open source project and requires your support. If you like this project, please consider supporting my work by clicking on the sponsor button on this Github repo or via Ko-Fi. Alternatively, Issues on React 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/CODEOFCONDUCT.md

License

MIT

Maintainers ✨

People maintaining this project.

Atul R
Atul R

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Rahul Gaba

πŸ’»

Kakul Gupta

πŸ’»

Eva1ent

πŸ’»

slidinghotdog

πŸ’»

Roy Sommer

πŸ’»

Natesh M Bhat

πŸ“–

Mikko Sairio

πŸ’»

Shubham Zanwar

πŸ’»

Serhii Matrunchyk

πŸ’»

Solant

πŸ’»

Christian Petersen

πŸ’»

Adam Gastineau

πŸ’»

gluaxspeed

πŸ’»

Chris Shepherd

πŸ’»

Jak

πŸ’»

Greg B

πŸ“–

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.