Quick start up guide

Welcome

To get started with OGX.JS, I recommend you to clone the demo repo to get a first look and explore.

You can also watch our video tutorial via our YouTube channel (content coming) and clone the tutorial repo.

You should also check out the CLI

Setup

To install the whole framework including the CLI (recommended), do

 npm init
 npm install @globules-io/ogx.cli -g

To install the framework only

 npm init
 npm install @globules-io/ogx.js

npm init is only required for a new installation/project

Install / update framework from CLI

 ogx update --force

Themes

OGX.JS supports themes (dark & light mode) and comes with a basic skin io-globules-ogx. You can explore and clone other themes in the repo dedicated to them here.

Configuration

The app.json is the configuration of your application. You can leverage the power of OML to prepare interfaces for you and to create as many objects that you want (at start). You can always create more objects at runtime.

The routing node of the app.json file is the routing for the entire application. It can also be modified at runtime.

Understading OGX.JS

It claims to be as abstract, at its core, as possible. The goal of this framework is the ability to render a tree of information mapped with a tree of objects, that displays and controls any node of the tree of information.

It is highly recommended to read about OML and OSE to grasp what this framework can do, which as an essential read to understand how to write a tree of objects and mapping data to it.

Cordova

OGX.JS can also be used with Cordova to create mobile applications. Here's how to setup your project

Install OGX.JS CLI globally

 npm install @globules-io/ogx.cli -g

Install Cordova globally

 npm install cordova -g

Create Cordova app

 cordova create MyApp

Move into root of app

 cd myapp

Remove www/index.html

Install OGX

 ogx update --force

Create default folders

 ogx init

Neutralino

OGX.JS can also be used with NeutralinoJS to create desktop applications. Here's how to setup your project

Install OGX.JS CLI globally

 npm install @globules-io/ogx.cli -g

Install Neutralino globally

 npm install @neutralinojs/neu -g

Create "myapp" folder (or whatever you want) then Move into root of app

 mkdir myapp
 cd myapp

Init package

 npm init

Install OGX

 ogx update --force

Create default folders

 ogx init

Update Neutralino

 neu update