https://github.com/parro-it/libui-napi
Experimental bindings for libui using n-api
https://github.com/parro-it/libui-napi
Last synced: 10 months ago
JSON representation
Experimental bindings for libui using n-api
- Host: GitHub
- URL: https://github.com/parro-it/libui-napi
- Owner: parro-it
- License: mit
- Created: 2018-05-01T07:44:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-11-16T06:55:55.000Z (about 4 years ago)
- Last Synced: 2024-10-06T09:25:16.603Z (over 1 year ago)
- Language: C
- Size: 3.75 MB
- Stars: 36
- Watchers: 6
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# libui-node
> Node.js bindings for [libui](https://github.com/andlabs/libui) library.
[libui](https://github.com/andlabs/libui) is a lightweight, portable GUI library that uses the native GUI technologies of each platform it supports.
It is in early stage of development, but is evolving at great pace and is really awesome. It could become an awesome alternative to Electron to develop multiplatform GUI, expecially suited to develop small apps.
[](https://spectrum.chat/libui-node)
[](http://travis-ci.org/parro-it/libui-node)
[](https://ci.appveyor.com/project/parro-it/libui-node)
[](https://npmjs.org/package/libui-node)
[](https://npmjs.org/package/libui-node)
# Screenshots
macOS
Linux
Windows
# Supported platforms
* Windows: Windows Vista SP2 with Platform Update or newer
* Unix: GTK+ 3.10 or newer
* Mac OS X: OS X 10.8 or newer
* Node.js version 4 or greater.
# Prerequisites
## Prebuilt binaries
All prebuilds are build on CI and afterwards downloaded and published in the npm install phase.
Prebuild t binaries are available for the following platforms:
* macOS 64bit
* Windows 64bit
* Linux 64bit
If you are using one of these platform, you don't need to recompile
libui-node source code from scratch.
The only additional dependecy you nedd is [GTK+ 3](https://packages.ubuntu.com/source/xenial/gtk+3.0) to run on Linux.
Otherwise, libui-node sources will be compiled during part of the `install`
phase. You need the following additionl dependency in order to compile:
## Windows
- [windows-build-tools](https://www.npmjs.com/package/windows-build-tools) or Visual Studio 2015 to compile the project.
- [Visual C++ Redistributable Package per Visual Studio 2013](https://www.microsoft.com/it-it/download/details.aspx?id=40784)
## Linux
If they are not provided by default in your distribution:
- [build-essential](https://packages.ubuntu.com/xenial/build-essential) to compile the project.
- [GTK+ 3](https://packages.ubuntu.com/source/xenial/gtk+-3.0)
## macOS
- [Xcode 8](https://developer.apple.com/xcode/) to compile the project.
# Installation
```bash
npm install -S libui-node
```
`libui` prebuilt binaries are automatically downloaded after install.
If you get this error on Windows:
```
'__pfnDliNotifyHook2': redefinition; different type modifiers
```
you need to install latest npm version:
```bash
$ npm i -g npm
```
see [this node-gyp issue](https://github.com/nodejs/node-gyp/issues/972)
for more details.
# Documentation & examples
Documentation is in [docs folder](docs).
You can also find working examples in [example folder](https://github.com/parro-it/libui-node/tree/master/example).
## How to run the examples
First, you have to clone the GitHub repo and npm install it:
```bash
git clone https://github.com/parro-it/libui-node.git
npm install
```
Then, to run the control gallery example (requires Node.js >= 6), type:
```bash
node example/core-api.js
```
# Contribution & design
1) Make sure to read and agree with our [code of conduct](CODE_OF_CONDUCT.md)
2) Follow guidelines provided in our [contribution guide](CONTRIBUTING.md)
# Related projects
* [libui](https://github.com/andlabs/libui) - Simple and portable (but not inflexible) GUI library in C that uses the native GUI technologies of each platform it supports.
* [nbind](https://github.com/charto/nbind) - Magical headers that make your C++ library accessible from JavaScript
* [proton-native](https://github.com/kusti8/proton-native) - A React environment for cross platform native desktop apps https://proton-native.js.org
* [vuido](https://vuido.mimec.org/) - Native desktop applications using Vue.js.
https://proton-native.js.org
# Contributors
[](https://github.com/parro-it) |
[](https://github.com/jjrv) |
[](https://github.com/mischnic) |
[](https://github.com/kusti8)
---|---|---|---
[Andrea Parodi](https://github.com/parro-it) | [Juha Järvi](https://github.com/jjrv) | [Niklas Mischkulnig](https://github.com/mischnic) | [Gustav Hansen](https://github.com/kusti8)
# License
The MIT License (MIT)
Copyright (c) 2018 parro-it