A web based mission control framework.
Go to file
Pete Richards 7890fcae69 tutorial consistency . ()
* [API] use new-style objects consistently

* rewrite todo tutorial in test-api.html

* [API] Add API doc, update object API

* [Tutorials] Rename tutorials, remove old

* Fix Links

* updates

* initial

* hope this works

* Object Utils always return new objects instead of mutating existing objects

* keep domain object model in-sync when listening

Keep the domain object model in sync with the latest version when
listening for mutation events.

* Remove old-style plugins

* Update views to use new API

* Tidy Code

* Update API Docs

* Add Plugin API and Example
2016-07-21 14:39:02 -07:00
docs [Tutorials] Updated tutorials to use new bundle registration mechanism 2016-05-17 17:24:32 -07:00
example [Example] REMS heirarchy appear as links 2016-05-20 17:11:07 -07:00
platform tutorial consistency . () 2016-07-21 14:39:02 -07:00
protractor [Tests] Comment out failing tests 2015-08-12 11:57:56 -07:00
scripts [Build] Tweak migration script 2016-03-04 10:43:42 -08:00
src tutorial consistency . () 2016-07-21 14:39:02 -07:00
tutorial-server [Tutorials] Add example server 2016-06-07 13:00:38 -07:00
tutorials tutorial consistency . () 2016-07-21 14:39:02 -07:00
.gitignore [Build] Generate CSS sourcemaps 2016-02-22 18:57:05 -08:00
.jscsrc [Code Style] Add JSHint rules 2016-05-12 16:32:17 -07:00
.jshintrc [Code Style] Disallow outer shadowing 2016-05-20 11:38:36 -07:00
.npmignore [Build] Add npmignore to allow packing 2016-02-12 11:47:28 -08:00
API.md tutorial consistency . () 2016-07-21 14:39:02 -07:00
app.js added command line option --directory -D to specify base directory 2016-05-05 21:58:31 -07:00
bower.json [API] UMD Packaging () 2016-07-07 14:25:23 -07:00
build-docs.sh [Website] Automate build process - Updated build SHA 2016-05-19 11:39:08 -07:00
circle.yml [Code Style] Specify lint, codestyle in CircleCI config 2016-05-23 15:10:05 -07:00
CONTRIBUTING.md [Branding] Remove Web from name at top-level 2016-05-04 10:08:55 -07:00
custom-view-react.html tutorial consistency . () 2016-07-21 14:39:02 -07:00
custom-view.html tutorial consistency . () 2016-07-21 14:39:02 -07:00
gulpfile.js [API] UMD Packaging () 2016-07-07 14:25:23 -07:00
index.html tutorial consistency . () 2016-07-21 14:39:02 -07:00
jsdoc.json [Code Style] Add trailing newline 2015-08-17 15:07:47 -07:00
karma.conf.js [Build] Enforce code coverage threshold 2016-03-03 17:14:04 -08:00
LICENSES.md [Frontend] Removed reset.css and refs to modernizr 2016-03-16 14:44:01 -07:00
main.js Mutation API () 2016-07-07 14:30:45 -07:00
object-provider.html tutorial consistency . () 2016-07-21 14:39:02 -07:00
package.json [Build] Bump version number, add -SNAPSHOT 2016-05-16 09:36:59 -07:00
plugin-example.html tutorial consistency . () 2016-07-21 14:39:02 -07:00
Procfile [CI] Remove non-existent bundle from procfile 2015-10-16 11:33:42 -07:00
README.md [Branding] Remove Web from name at top-level 2016-05-04 10:08:55 -07:00
test-main.js Mutation API () 2016-07-07 14:30:45 -07:00

Open MCT

Open MCT is a web-based platform for mission operations user interface software.

Bundles

A bundle is a group of software components (including source code, declared as AMD modules, as well as resources such as images and HTML templates) that are intended to be added or removed as a single unit. A plug-in for Open MCT will be expressed as a bundle; platform components are also expressed as bundles.

A bundle is also just a directory which contains a file bundle.json, which declares its contents.

The file bundles.json (note the plural), at the top level of the repository, is a JSON file containing an array of all bundles (expressed as directory names) to include in a running instance of Open MCT. Adding or removing paths from this list will add or remove bundles from the running application.

Tests

Tests are written for Jasmine 1.3 and run by Karma. To run:

npm test

The test suite is configured to load any scripts ending with Spec.js found in the src hierarchy. Full configuration details are found in karma.conf.js. By convention, unit test scripts should be located alongside the units that they test; for example, src/foo/Bar.js would be tested by src/foo/BarSpec.js. (For legacy reasons, some existing tests may be located in separate test folders near the units they test, but the naming convention is otherwise the same.)

Test Reporting

When npm test is run, test results will be written as HTML to target/tests. Code coverage information is written to target/coverage.

Functional Testing

The tests described above are all at the unit-level; an additional test suite using Protractor is under development, in the protractor folder.

To run:

  • Install protractor following the instructions above.
  • cd protractor
  • npm install
  • npm run all

Build

Open MCT is built using npm and gulp.

To build:

npm run prepublish

This will compile and minify JavaScript sources, as well as copy over assets. The contents of the dist folder will contain a runnable Open MCT instance (e.g. by starting an HTTP server in that directory), including:

  • A main.js file containing Open MCT source code.
  • Various assets in the example and platform directories.
  • An index.html that runs Open MCT in its default configuration.

Additional gulp tasks are defined in the gulpfile.

Building Documentation

Open MCT's documentation is generated by an npm-based build. It has additional dependencies that may not be available on every platform and thus is not covered in the standard npm install. Ensure your system has libcairo installed and then run the following commands:

  • npm install
  • npm install canvas nomnoml
  • npm run docs

Documentation will be generated in target/docs.

Glossary

Certain terms are used throughout Open MCT with consistent meanings or conventions. Any deviations from the below are issues and should be addressed (either by updating this glossary or changing code to reflect correct usage.) Other developer documentation, particularly in-line documentation, may presume an understanding of these terms.

  • bundle: A bundle is a removable, reusable grouping of software elements. The application is composed of bundles. Plug-ins are bundles. For more information, refer to framework documentation (under platform/framework.)
  • capability: An object which exposes dynamic behavior or non-persistent state associated with a domain object.
  • composition: In the context of a domain object, this refers to the set of other domain objects that compose or are contained by that object. A domain object's composition is the set of domain objects that should appear immediately beneath it in a tree hierarchy. A domain object's composition is described in its model as an array of id's; its composition capability provides a means to retrieve the actual domain object instances associated with these identifiers asynchronously.
  • description: When used as an object property, this refers to the human-readable description of a thing; usually a single sentence or short paragraph. (Most often used in the context of extensions, domain object models, or other similar application-specific objects.)
  • domain object: A meaningful object to the user; a distinct thing in the work support by Open MCT. Anything that appears in the left-hand tree is a domain object.
  • extension: An extension is a unit of functionality exposed to the platform in a declarative fashion by a bundle. For more information, refer to framework documentation (under platform/framework.)
  • id: A string which uniquely identifies a domain object.
  • key: When used as an object property, this refers to the machine-readable identifier for a specific thing in a set of things. (Most often used in the context of extensions or other similar application-specific object sets.)
  • model: The persistent state associated with a domain object. A domain object's model is a JavaScript object which can be converted to JSON without losing information (that is, it contains no methods.)
  • name: When used as an object property, this refers to the human-readable name for a thing. (Most often used in the context of extensions, domain object models, or other similar application-specific objects.)
  • navigation: Refers to the current state of the application with respect to the user's expressed interest in a specific domain object; e.g. when a user clicks on a domain object in the tree, they are navigating to it, and it is thereafter considered the navigated object (until the user makes another such choice.)
  • space: A name used to identify a persistence store. Interactions with persistence with generally involve a space parameter in some form, to distinguish multiple persistence stores from one another (for cases where there are multiple valid persistence locations available.)