nodegui/react-nodegui

README

React NodeGui

⚠️ React NodeGui is no longer maintained. Please fork it to continue development ⚠️

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.

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?

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

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

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=<your_git_username> 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.

Special Thanks

Logo: Thanks to Vishwas Shetty from the Noun Project.

Code of Conduct

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

License

MIT

Maintainers ✨

People maintaining this project.

_{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} 📖	_{Nathaniel van Diepen} 💻	_{KR Tirtho} 💻	_theLMGN 💻	_KaMeHb-UA 💻

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

React NodeGui

⚠️ React NodeGui is no longer maintained. Please fork it to continue development ⚠️

Build performant, native and cross-platform desktop applications with React.🚀

Visit: https://react.nodegui.org for docs.

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?

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

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

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=<your_git_username> yarn deploy

Funding

Special Thanks

Logo: Thanks to Vishwas Shetty from the Noun Project.

Code of Conduct

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

License

MIT

Maintainers ✨

People maintaining this project.

_{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} 📖	_{Nathaniel van Diepen} 💻	_{KR Tirtho} 💻	_theLMGN 💻	_KaMeHb-UA 💻

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

gem-hunter