Skip to content
JavaScript-based front-end for OpenADMS Node and Apache CouchDB.
CSS JavaScript Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
semantic
src
.gitignore
LICENCE
README.md
index.html
package.json
run.sh
semantic.json
webpack.config.js

README.md

OpenADMS UI

OpenADMS UI is a single-page application for the remote control of OpenADMS Node and OpenADMS Server instances. It is written in ECMAScript 2015 and relies on jQuery, Backbone.js, Underscore.js, Semantic UI, and PouchDB.

Run

Launch OpenADMS UI by simply serving the root directory with a web server (nginx, Hiawatha, httpd, …). For testing, you can start the Python HTTP server module inside the OpenADMS UI directory (or execute run.sh):

$ cd ../
$ python3 -m http.server 8080

Open your web browser and access http://localhost:8080/openadms-ui/. OpenADMS UI must be served from path openadms-ui/. Otherwise, change rootPath in src/openadms-ui.js to the actual path and re-build the sources.

Build

Node.js and npm are required to build OpenADMS UI. Clone the repository with Git and run:

$ npm install

Build OpenADMS UI with:

$ npm run-script build

The output file bundle.js will be saved to assets/js/. If you change any Semantic UI styles, re-package the CSS files with Gulp:

$ cd semantic/
$ ../node_modules/gulp/bin/gulp.js build-css

The compiled CSS files semantic.css and semantic.min.css will be stored in assets/css/.

Writing Apps

OpenADMS UI can be extended by writing additional Apps. Add an App directory to src/apps/ and place the following files inside it:

  • meta.json (App information),
  • template.html (Underscore.js template),
  • app.js (App script, may be empty).

The JSON file meta.json stores all information regarding the App:

{
  "name": "myapp",
  "title": "My App",
  "icon": "puzzle",
  "menu": true
}

The name must equal the name of the App directory. The title will be displayed in the Underscore.js template. The icon can be changed to a valid Semantic UI icon name. If menu is set to true, a link to the App will be added to the top menu.

The template file template.html contains the HTML elements and optional Underscore.js placeholders for meta values.

The App script app.js will be run as a JavaScript function each time the App is loaded. The variable args is given as an argument to the App function and stores the complete routing path beyond the App name (e. g., #apps/myapp/<args>).

Loading the App

Enable the App by adding the App name to autoload in src/apps/apps.json. Open http://localhost:8080/openadms-ui/#apps/myapp to display the App.

Subordinate Apps

Apps can have subordinate Apps. You may want to use the UI.loadApps() function to load them deferred.

JSDoc

Run JSDoc to generate the source code documentation:

$ ./node_modules/jsdoc/jsdoc.js -r ./src -d ./docs

You will find the HTML pages in directory docs/.

Licence

OpenADMS UI is distributed under the BSD-2-Clause licence.

You can’t perform that action at this time.