Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

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

css desktop gui hacktoberfest javascript native nodejs openlibrary qt typescript vue vue-desktop vue3

Last synced: 5 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/nodegui/vue-nodegui
Owner: nodegui
License: mit
Created: 2020-03-12T05:00:50.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-01-07T21:23:43.000Z (almost 2 years ago)
Last Synced: 2024-10-11T20:15:31.305Z (2 months ago)
Topics: css, desktop, gui, hacktoberfest, javascript, native, nodejs, openlibrary, qt, typescript, vue, vue-desktop, vue3
Language: TypeScript
Homepage: https://vue.nodegui.org
Size: 6.7 MB
Stars: 808
Watchers: 11
Forks: 28
Open Issues: 55
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-nodegui - Vue NodeGui - Vue renderer for NodeGui. (Renderers)

README

# Vue NodeGui

[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)

[![Join the NodeGUI community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/nodegui)

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

Vue NodeGUI is powered by **Vue** 🌈 and **Qt5** 💚 which makes it CPU and memory efficient as compared to other chromium based solutions like electron. Vue NodeGUI is essentially a Vue renderer for [NodeGUI](https://github.com/nodegui/nodegui).

Visit: https://vue.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. 🚧

## 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 documentation and website.
- 🧙‍♂️ Good documentation for contributors.
- 🦹🏻‍♀️ Good support for dark mode (Thanks to QT).

## Getting Started

- Check out the [vue-nodegui starter repo](https://github.com/nodegui/vue-nodegui-starter)
- Read through the [docs](https://vue.nodegui.org)

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

Vue 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 / Patreon. We will soon launch issuehunt.