Giter VIP home page Giter VIP logo

vuido's Introduction

Vuido

Create native desktop applications for Windows, OS X and Linux using Vue.js.

NPM module MIT License

Introduction

Vuido makes it possible to create lightweight, native desktop applications using Vue.js. Application using Vuido can run on Windows, OS X and Linux, using native GUI components, and don't require Electron.

Under the hood, Vuido uses the libui library which provides native GUI components for each desktop platform, and the libui-node bindings for Node.js.

Vuido supports most of the standard Vue.js API and it's compatible with many Vue.js extensions, for example Vuex. Applications using Vuido can also use all standard Node.js modules and any packages compatible with Node.js.

Prerequisites

The following prerequisites are needed to compile libui-node, which is used by Vuido.

Windows

npm install --global --production windows-build-tools

Linux

If they are not provided by default in your distribution:

Ubuntu / Debian

sudo apt install build-essential libgtk-3-dev

OS X

  • Xcode
xcode-select --install

Quick setup

The easiest way to start using Vuido is to use vue-cli to create the scaffolding of the project.

First make sure that vue-cli is installed globally:

npm install -g vue-cli

Run the following command to create the project (replace my-project with the name of your project):

vue init mimecorg/vuido-webpack-template my-project

Enter the directory created by vue-cli and install all dependencies:

cd my-project
npm install

Now you can build and run your application:

npm run build
npm start

Packaging

Although native desktop applications can run in the standard Node.js environment, it is recommended to use LaunchUI to package and distribute them to end users.

The easiest way to create a package for your application is to use the LaunchUI Packager. It provides an API for creating packages for Windows, Linux and OS X.

Documentation

You can find the full documentation of Vuido at vuido.mimec.org.

Development status

At the moment Vuido is in a very early stage of development. The main goal is to implement all remaining controls currently supported by libui.

Acknowledgements

Vuido is largely based on Vue.js and shares most of its code, except for the platform specific code related to libui.

Vuido was inspired by Proton Native, an environment for creating native desktop applications using React.

License

Vuido is licensed under the MIT license

Copyright (C) 2018 Michał Męciński

vuido's People

Contributors

mimecorg avatar xpyct avatar mbackonja avatar atilacamurca avatar jurrianfahner avatar probil avatar chinanf-boy avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.