Publishing Ombori Gridapps

Owned by Jovanni Auxilio, created
Last updated: Mar 01, 2021 by Former user (Deleted)
2 min read

This page is a guide for Ombori developers on How to publish Ombori Developed Gridapps releases

General

One time project set-up:

  1. In your project root, make sure you use latest ga-cli,
    “yarn add @ombori/ga-cli@latest --dev”

  2. Update your scripts in package.json as below:
    "prodbuild": "cross-env GENERATE_SOURCEMAP=false react-scripts build && cp package.json build/", "build": "rimraf build && yarn prodbuild && omg app build",

Ombori Public Apps

Apps that are available to all organizations in Grid

Every new Release:

  1. For projects without CI, bump version manually in package.json
    ”version”: “X.X.X”

  2. Build the app with updated version
    ”yarn build”

  3. Upload the generated gridapp in Ombori / Apps section in Grid Console

  4. There should be no duplicate versions in the list

App Name

App

Store Link

Repo

Description

App Name

App

Store Link

Repo

Description

Digital Signage

https://console.omborigrid.com/organisations/5cbac8a388e174147b878cdd/apps-library/6013e3c0f78cb316ad7ed2bf/versions

https://github.com/ombori/generic-gridapps/tree/master/apps/digital-signage

Playlist, triggers, nested gridapps

Queue Signage

https://console.omborigrid.com/organisations/5cbac8a388e174147b878cdd/apps-library/5fd8dfe9a1d0eb0a63536096/versions

https://github.com/ombori/queue-signage/tree/master/packages/ombori-signage

People count Queue Signage

Small Queue Ticket Signage

https://console.omborigrid.com/organisations/5cbac8a388e174147b878cdd/apps-library/602e9297cffaae3a80f0c44f/versions

https://github.com/ombori/queue-signage/tree/master/packages/ica-sm-signage

Small (Usually Tizen) Queue Ticket Signage. Example, ICA, Kjell

Stations Signage



https://console.omborigrid.com/organisations/5cbac8a388e174147b878cdd/apps-library/601138e0eb47806ca50914ab/versions

Queue signage that shows called tickets for different stations

Ombori Developed Private Apps

Apps that should be exclusively available to specific organizations. Example, ITAB-CNC-GUI

Every new Release:

  1. For projects without CI, bump version manually in package.json
    npm version <level>, level can be major, minor or patch

  2. Build the app with updated version
    yarn build

  3. Make sure your app has non-emply ‘package name’ field on app settings form.
    NOTE: if you cannot save the form, try entering any value in ‘comments’ field.

  4. Upload the generated build to your app
    omg app publish <orgName>.<pkgName>, orgName is app’s organisation name, pkgName is package name for the application.

  5. There should be no duplicate versions in the list

Publishing app description

You can add app description on applications page in ombori console.

To publish you own description, create a file called DESCRIPTION.md in project’s root folder

DESCRIPTION.md file format

The file is a standard Markdown, with few additions (see example: https://github.com/ombori/queue-signage/blob/master/packages/ombori-signage/DESCRIPTION.md )

# Queue Signage # by Ombori A reference signage application for Ombori Queue. Occupation and ticket display for TV and Grid-OS devices. ![Main Screen](meta/screen1.png) ![Vertical screen layout, store almost full](meta/screen2.png) ![Store is full](meta/screen3.png) This app should be used in conjunction with [Xovis people sensor](https://www.xovis.com/en/products/detail/pc2/). Optional relay module can be used to control entrance doors or gate. Setup and configuration documentation is available [here](http://ombori.com) ## Features: - occupancy display - ticket display - offline operation - text-to-speech support - external relay module support - customizeable colors and icons - fully localizeable - vertical and horizontal display orientation

Here the first paragraph is an application name and full name of the author.

Second paragraph is a short description that will be displayed in the list of applications in app library.

Next, the optional screenshots. The screenshot files should be stored in the same repository.

The content after the screenshots will be rendered as a regular markdown text on app description page.

Publishing

To publish your description, run omg app upload-description <orgName>.<pkgName> Note that app title, description and author fields will be overwritten.