gitter-badger / ugui Goto Github PK

This project forked from universalgui/ugui

0.0 1.0 0.0 30.61 MB

Universal Graphical User Interface

License: MIT License

HTML 2.41% CSS 85.51% JavaScript 12.08%

ugui's Introduction

##Universal Graphical User Interface

UGUI gives a face to command line programs, and that face is HTML, CSS, & JS.

Create your own cross-platform desktop applications in minutes using UGUI.

###Download

Download UGUI to use it for your project:

###What is UGUI?

Simply typing ugui into the console gives you a wealth of useful information and helper functions for common tasks.

We supply you with common elements like navigation, "about" info, form elements, and 19 premade themes to pick from.

Boilerplate: A general purpose compilation of commonly used tools for NW.js.

UGUI's project structure can be used for any kind of desktop app, or in combination with other common web frameworks, such as Angular or React. Many basic things (such as a detailed package.json for NW.js or code for making a Tray app) are already taken care of.

Educational Platform: We believe UGUI can be used by anyone, even those with no coding experience. As part of this belief we approach everything from a UX perspective of making it as easy to understand as possible. This is why nearly every line of code in ugui.js is commented, and why we put such a focus on documentation and tutorials.

Our goal is to allow anyone, even those with no prior coding knowledge, to create a desktop application in just 5 minutes.

###Project Roadmap

Current Version of Master Branch: V1.2.0

Phase 1: The library and framwork.

V1.3 Clean up UGUI API
Change sync for readAFolder
Check for Updates
V1.4 Multi-File import
V1.5 Add some type of JSHint-like library to UGUI Dev Tools to inform developers about syntax errors.
V1.6 NW.js plans to implement a native spellchecker in version 13, if that doesn't occur, implement one into UGUI.

Phase 2: Site: Templates, Tutorials, & Documentation

Phase 3: UGUI Designer: The wizard and automation studio

Ultimately I'd like to make a program that makes this whole process far less manual. The program, UGUI Designer, would have the following features:

Detect all JS and CSS files, uglify, minify, concat them in to one JS and one CSS doc.
Remove any files not being used in the production version (git files, sass, etc.)
Ability to export project to different environments (Win 32/64, Ubuntu, OSX, etc.)
Eventually the exporting function would create an installer for Windows that will check if the required version of NW.js is already installed and if not download and install it, allowing for much smaller file sizes when packaging and distributing.

###Known Issues

Loading settings doesn't update the value of <input type="file">. It does update it's internal file list though and should be functional if ran. There seems to currently be no method of updating the value of these elements due to security restrictions originally placed in Chromium. To get around this, we visually update the EZDZ plugin to make it look as though it's been updated, this however will not make a required <input type="file"> activate as being fullfilled until the user interacts with it. To work around this you can give the EZDZ input a class of do-not-save or remove the required="required".
Range slider value is empty in the UGUI Arg Obj (window.ugui.args) on load. This doesn't matter though as it will get it's value when clicking run or any other form element with a data-argName, which in turn updates the UGUI Developer Toolbar's CMD Output Preview. Will not fix. Will accept pull request.

###Credits

People

The Jared Wilcurt - Creator/Maintainer
Dan O'Dea - Definition Pattern Matching Engine Architect - Save/Load Settings features
Hai Nguyen - UGUI Project Architecture Consultant
Stephan Raab - UGUI Website Designer
Grahammer - UGUI Engine Architecture Consultant
Boyma Fahnbulleh - Beta, Realworld, and OSX testing

Technology