Publishing Ombori Gridapps
- Jovanni Auxilio (Unlicensed)
- Former user (Deleted)
This page is a guide for Ombori developers on How to publish Ombori Developed Gridapps releases
General
One time project set-up:
In your project root, make sure you use latest ga-cli,
“yarn add@ombori/ga-cli@latest --dev”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:
For projects without CI, bump version manually in package.json
”version”: “X.X.X”Build the app with updated version
”yarn build”Upload the generated gridapp in Ombori / Apps section in Grid Console
There should be no duplicate versions in the list
App Name | App Store Link | Repo | Description |
|---|---|---|---|
Digital Signage | https://github.com/ombori/generic-gridapps/tree/master/apps/digital-signage | Playlist, triggers, nested gridapps | |
Queue Signage | https://github.com/ombori/queue-signage/tree/master/packages/ombori-signage | People count Queue Signage | |
Small Queue Ticket Signage | https://github.com/ombori/queue-signage/tree/master/packages/ica-sm-signage | Small (Usually Tizen) Queue Ticket Signage. Example, ICA, Kjell | |
Stations Signage | https://github.com/ombori/queue-signage/tree/master/packages/stations-signage | 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:
For projects without CI, bump version manually in package.json
npm version <level>, level can bemajor,minororpatchBuild the app with updated version
yarn buildMake 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.Upload the generated build to your app
omg app publish <orgName>.<pkgName>,orgNameis app’s organisation name,pkgNameis package name for the application.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.
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 orientationHere 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.