Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More โ†’
Socket
Sign inDemoInstall
Socket

@nodegui/nodegui

Package Overview
Dependencies
Maintainers
3
Versions
136
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@nodegui/nodegui

A cross platform library to build native desktop apps.

  • 0.15.3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
593
decreased by-12.02%
Maintainers
3
Weekly downloads
ย 
Created
Source

NodeGui

Join the NodeGUI community on Spectrum All Contributors JS Party #96

Build and Test status

Build performant, native and cross-platform desktop applications with Node.js and 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 ๐Ÿ˜‰).

Getting Started

Installation

To install latest stable release:
npm install @nodegui/nodegui
To install the latest version available on master branch:
npm install https://github.com/nodegui/nodegui/releases/download/v0.0.0-latest-master/nodegui-master.tgz

or a shorter version:

npm i http://master-release.nodegui.org

Community guides

Talks/Podcasts

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.

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

Building

npm run build

Optionally set QT_INSTALL_DIR='/path/to/qt' environment variable to build using your own version of Qt.

Funding

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 repository or via 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

Code of Conduct

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

License

MIT

Backers ๐Ÿš€

Thanks goes to these wonderful people.

Yuriy Yazlovytskyy
Yuriy Yazlovytskyy
John Susek
John Susek
Marc Dijoux
Marc Dijoux
Stephen Belanger
Stephen Belanger
Rustam
Rustam

Maintainers โœจ

People maintaining this project.

Atul R
Atul R
Dimitar
Dimitar Nestorov

Contributors โœจ

Thanks goes to these wonderful people (emoji key):


Lucas Ramage

๐Ÿ“–

Denis Sikuler

๐Ÿ“–

Nahuel Josรฉ

๐Ÿ’ฌ

Kakul Gupta

๐Ÿ’ป

Rahul Gaba

๐Ÿ’ป

Paweล‚ Borecki

๐Ÿ’ป

Marcus S. Abildskov

โš ๏ธ

รtila Camurรงa Alves

๐Ÿ“–

James Hibbard

๐Ÿ’ป

Soonwoo Hong

๐Ÿ’ป

Roy Sommer

๐Ÿ’ป

Paulo Coghi

๐Ÿค”

Balthild Ires

๐Ÿ’ป

Dimitar Nestorov

๐Ÿ’ป

Mikko Sairio

๐Ÿ’ป

Pepijn

๐Ÿ’ป

slidinghotdog

๐Ÿ’ป

Bundyo (Kamen Bundev)

๐Ÿ’ป

feng8848

๐Ÿ’ป

Maksim Karelov

๐Ÿ’ป

mspencer92

๐Ÿ’ป

blncd2020

๐Ÿ“–

gluaxspeed

๐Ÿ’ป

Solant

๐Ÿ’ป

Shubham Zanwar

๐Ÿ’ป

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

Keywords

FAQs

Package last updated on 08 Mar 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with โšก๏ธ by Socket Inc