Skip to content
Build performant, native and cross-platform desktop applications with native React + powerful CSS like styling.πŸš€
TypeScript JavaScript CSS
Branch: master
Clone or download

Latest commit

dependabot Bump acorn from 6.4.0 to 6.4.1 in /website (#163)
Bumps [acorn](https://github.com/acornjs/acorn) from 6.4.0 to 6.4.1.
- [Release notes](https://github.com/acornjs/acorn/releases)
- [Commits](acornjs/acorn@6.4.0...6.4.1)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Latest commit cbba232 Mar 25, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Delete FUNDING.yml Mar 15, 2020
examples Updates dev dependencies Aug 17, 2019
extras/assets Adds hot-reload support Nov 3, 2019
src tabs: uncommenting the insertChild method (#176) Mar 25, 2020
website Bump acorn from 6.4.0 to 6.4.1 in /website (#163) Mar 25, 2020
.all-contributorsrc docs: add fnky as a contributor (#168) Mar 18, 2020
.gitignore base boiler plate Jun 23, 2019
.npmignore Adds useeventHandler hook and upgrades NodeGui Aug 11, 2019
LICENSE added LICENSE to the project Sep 7, 2019
README.md docs: add fnky as a contributor (#168) Mar 18, 2020
package-lock.json Bump typedoc from 0.16.11 to 0.17.3 (#174) Mar 25, 2020
package.json Bump typedoc from 0.16.11 to 0.17.3 (#174) Mar 25, 2020
tsconfig.json remove sourcemaps Nov 24, 2019

README.md

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

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 [--qt_home_dir=/path/to/qt]

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/CODE_OF_CONDUCT.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

πŸ’»

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

You can’t perform that action at this time.