Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nodegui/react-nodegui

Build performant, native and cross-platform desktop applications with native React + powerful CSS like styling.🚀
https://github.com/nodegui/react-nodegui

css desktop gui native nodejs openlibrary qt react react-desktop

Last synced: 3 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/nodegui/react-nodegui
Owner: nodegui
License: mit
Created: 2019-06-23T20:41:01.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-11-03T01:50:26.000Z (about 1 year ago)
Last Synced: 2024-11-26T13:04:37.001Z (17 days ago)
Topics: css, desktop, gui, native, nodejs, openlibrary, qt, react, react-desktop
Language: TypeScript
Homepage: https://react.nodegui.org
Size: 9.03 MB
Stars: 6,184
Watchers: 69
Forks: 171
Open Issues: 53
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-list - react-nodegui - platform desktop applications with native React + powerful CSS like styling.🚀 | nodegui | 5829 | (TypeScript)
awesome-react-renderer - React NodeGUI - Build performant, native and cross-platform desktop applications with native React + powerful CSS like styling.🚀 (Desktop)
awesome-github-star - react-nodegui - platform desktop applications with native React + powerful CSS like styling.🚀 | nodegui | 6146 | (TypeScript)
awesome-nodegui - React NodeGui - Build performant, native and cross-platform desktop applications with native React + powerful CSS like styling.🚀 (Renderers)

README

# React NodeGui

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

[![Join the NodeGUI community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/nodegui)
[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#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](https://github.com/nodegui/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](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 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](https://github.com/nodegui/react-nodegui-starter) to get up and running with your own React NodeGUI app!
- Read through the [docs](https://react.nodegui.org)

**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](https://blog.logrocket.com/author/siegfriedgrimbeek/).

**Talks/Podcasts**

- [NodeGui and React NodeGui at KarmaJS Nov 2019 meetup: https://www.youtube.com/watch?v=8jH5gaEEDv4](https://www.youtube.com/watch?v=8jH5gaEEDv4)

JS Party 96: Performant Node desktop apps with NodeGUI – Listen on Changelog.com

## 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.